update contributor docs #9190
Merged
update contributor docs #9190
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
colin-axner
requested review from
aaronc,
alessio and
alexanderbez
as code owners
colin-axner
commented
Apr 23, 2021
Comment on lines
-54
to
-56
| Take a peek at our [coding repo](https://github.com/tendermint/coding) for | ||
| overall information on repository workflow and standards. Note, we use `make tools` for installing the linting tools. | ||
|
|
There was a problem hiding this comment.
this repo looks deserted, don't think we need to send contributors there imo
| @@ -69,7 +66,7 @@ Other notes: | |||
| When proposing an architecture decision for the SDK, please create an [ADR](./docs/architecture/README.md) | |||
| so further discussions can be made. We are following this process so all involved parties are in | |||
| agreement before any party begins coding the proposed implementation. If you would like to see some examples | |||
| of how these are written refer to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/architecture) | |||
| of how these are written refer to the current [ADRs](https://github.com/cosmos/cosmos-sdk/tree/master/docs/architecture) | |||
There was a problem hiding this comment.
plenty of good example adrs in the SDK now
| @@ -169,12 +166,7 @@ For example, in vscode your `.vscode/settings.json` should look like: | |||
|
|
|||
| ## Testing | |||
|
|
|||
| All repos should be hooked up to [CircleCI](https://circleci.com/). | |||
There was a problem hiding this comment.
I don't think CircleCI is used anymore?
| @@ -212,8 +204,7 @@ The SDK utilizes [semantic versioning](https://semver.org/). | |||
| Ensure that you base and target your PR on the `master` branch. | |||
|
|
|||
| All feature additions should be targeted against `master`. Bug fixes for an outstanding release candidate | |||
| should be targeted against the release candidate branch. Release candidate branches themselves should be the | |||
| only pull requests targeted directly against master. | |||
There was a problem hiding this comment.
The last sentence sounds like it was from the time when there was a develop branch
tac0turtle
approved these changes
Apr 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I was using the SDK contributor docs as a guideline for ibc-go and noticed some out of date sections
closes: #XXXX
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes