docs: update contributing (#13137)
Co-authored-by: Marko <marbar3778@yahoo.com>
This commit is contained in:
parent
f5f84ad12a
commit
7a3ff0dd4a
@ -31,7 +31,7 @@ discussion or proposing code changes. To ensure a smooth workflow for all
|
||||
contributors, the general procedure for contributing has been established:
|
||||
|
||||
1. Start by browsing [new issues](https://github.com/cosmos/cosmos-sdk/issues) and [discussions](https://github.com/cosmos/cosmos-sdk/discussions). If you are looking for something interesting or if you have something in your mind, there is a chance it had been discussed.
|
||||
* Looking for a good place to start contributing? How about checking out some [good first issues](https://github.com/cosmos/cosmos-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)?
|
||||
* Looking for a good place to start contributing? How about checking out some [good first issues](https://github.com/cosmos/cosmos-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [bugs](https://github.com/cosmos/cosmos-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22T%3A+Bug%22)?
|
||||
2. Determine whether a GitHub issue or discussion is more appropriate for your needs:
|
||||
1. If want to propose something new that requires specification or an additional design, or you would like to change a process, start with a [new discussion](https://github.com/cosmos/cosmos-sdk/discussions/new). With discussions, we can better handle the design process using discussion threads. A discussion usually leads to one or more issues.
|
||||
2. If the issue you want addressed is a specific proposal or a bug, then open a [new issue](https://github.com/cosmos/cosmos-sdk/issues/new/choose).
|
||||
@ -53,20 +53,18 @@ taken place in a GitHub issue, that PR runs a high likelihood of being rejected.
|
||||
|
||||
## Teams Dev Calls
|
||||
|
||||
The Cosmos SDK has many stakeholders contributing and shaping the project. Regen Network Development leads the Cosmos SDK R&D, and welcomes long-term contributors and additional maintainers from other projects. We use self-organizing principles to coordinate and collaborate across organizations in structured "Working Groups" that focus on specific problem domains or architectural components of the Cosmos SDK.
|
||||
The Cosmos SDK has many stakeholders contributing and shaping the project. The Core SDK team is composed of Interchain GmbH and Regen Network Development developers. Any long-term contributors and additional maintainers from other projects are welcome. We use self-organizing principles to coordinate and collaborate across organizations in structured "EPIC" that focus on specific problem domains or architectural components of the Cosmos SDK.
|
||||
|
||||
The developers are organized in working groups which are listed on a ["Working Groups & Arch Process" Github Issue](https://github.com/cosmos/cosmos-sdk/issues/9058) (pinned at the top of the [issues list](https://github.com/cosmos/cosmos-sdk/issues)).
|
||||
The developers work in sprints, which are available in a [GitHub Project](https://github.com/orgs/cosmos/projects/26/views/22). The current EPICs are pinned at the top of the [issues list](https://github.com/cosmos/cosmos-sdk/issues).
|
||||
|
||||
The important development announcements are shared on [Discord](https://discord.com/invite/cosmosnetwork) in the \#dev-announcements channel.
|
||||
The important development announcements are shared on [Discord](https://discord.com/invite/cosmosnetwork) in the `#dev-announcements` channel.
|
||||
|
||||
To synchronize we have few major meetings:
|
||||
|
||||
* Architecture calls: bi-weekly on Fridays at 14:00 UTC (alternating with the grooming meeting below).
|
||||
* Grooming / Planning: bi-weekly on Fridays at 14:00 UTC (alternating with the architecture meeting above).
|
||||
* Cosmos Community SDK Development Call on the last Wednesday of every month at 17:00 UTC.
|
||||
* Cosmos Roadmap Prioritization every 4 weeks on Tuesday at 15:00 UTC (limited participation).
|
||||
* Cosmos SDK Sprint Review on Monday and Thursday at 14:00 UTC (limited participation to core devs).
|
||||
* Cosmos SDK Community Call on Thursday at 16:00 UTC.
|
||||
|
||||
If you would like to join one of those calls, then please contact us on [Discord](https://discord.com/invite/cosmosnetwork) or reach out directly to Marko (@marbar3778).
|
||||
If you would like to join one of the community call, then please contact us on [Discord](https://discord.com/invite/cosmosnetwork) or reach out directly to Marko (@marbar3778).
|
||||
|
||||
## Architecture Decision Records (ADR)
|
||||
|
||||
@ -161,7 +159,7 @@ If you open a PR on the Cosmos SDK, it is mandatory to update the relevant docum
|
||||
|
||||
* If your change relates to the core SDK (baseapp, store, ...), be sure to update the content in `docs/basics/`, `docs/core/` and/or `docs/building-modules/` folders.
|
||||
* If your changes relate to the core of the CLI (not specifically to module's CLI/Rest), then modify the content in the `docs/run-node/` folder.
|
||||
* If your changes relate to a module, then be sure to update the module's spec in `x/moduleName/docs/spec/`.
|
||||
* If your changes relate to a module, then be sure to update the module's spec in `x/{moduleName}/docs/spec/`.
|
||||
|
||||
When writing documentation, follow the [Documentation Writing Guidelines](./docs/DOC_WRITING_GUIDELINES.md).
|
||||
|
||||
@ -207,7 +205,6 @@ For example, in vscode your `.vscode/settings.json` should look like:
|
||||
"protoc": {
|
||||
"options": [
|
||||
"--proto_path=${workspaceRoot}/proto",
|
||||
"--proto_path=${workspaceRoot}/third_party/proto"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -287,8 +284,7 @@ is broken up into three distinct stages: **Strategy Discovery**, **Concept Appro
|
||||
|
||||
#### Time Bound Period
|
||||
|
||||
* Once a PR for an ADR is opened, reviewers are expected to perform a first
|
||||
review within 1 week of pull request being open
|
||||
* Once a PR for an ADR is opened, reviewers are expected to perform a first review within 1 week of pull request being open
|
||||
* Time bound period for individual ADR Pull Requests to be merged should not exceed 2 weeks
|
||||
* Total time bound period for an ADR to reach a decision (`ABANDONED | ACCEPTED | REJECTED`) should not exceed 4 weeks
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user