Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc for contributing guidelines #744

Merged
merged 16 commits into from
Mar 6, 2023
Merged

Doc for contributing guidelines #744

merged 16 commits into from
Mar 6, 2023

Conversation

shaspitz
Copy link
Contributor

@shaspitz shaspitz commented Feb 28, 2023

Description

Adds guidelines for contributing to ICS, along with a way that we could start incorporating semantic versioning into the repo.

See https://github.com/cosmos/gaia/blob/main/CONTRIBUTING.md#pull-requests and https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md for examples from sdk and gaia.

Linked issues

Automation for semver is tracked as #748

Type of change

  • Docs: Adds documentation

Regression tests

n/a

New behavior tests

n/a

Incrementing a MINOR version number indicates that a PR is only consensus breaking to the provider, or only to the consumers. Be careful in this scenario, as state-transition changes to the provider can often lead to differences in how validator set changes are relayed to the consumers.

Incrementing a PATCH version number indicates that a PR is not consensus breaking to the provider or consumers.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for api breaking, it goes to patch ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For node API changes, yes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
@shaspitz shaspitz marked this pull request as ready for review February 28, 2023 22:50
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@shaspitz shaspitz requested a review from mpoke March 2, 2023 22:19
Copy link
Contributor

@mpoke mpoke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @smarshall-spitzbart

@sainoe sainoe merged commit cc8c7fe into main Mar 6, 2023
@sainoe sainoe deleted the contributing-docs branch March 6, 2023 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants