mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 01:11:10 +00:00
add new documentation guidelines (#14115)
* add new documentation style-guides * update CODEOWNERS as well * try new team * revert * Update docs/DOCUMENTATION_GUIDELINES.md Co-authored-by: Juan <juangirini@gmail.com> * Update docs/DOCUMENTATION_GUIDELINES.md Co-authored-by: Juan <juangirini@gmail.com> * Apply suggestions from code review Co-authored-by: Ben Greenberg <13892277+hummusonrails@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Sam Johnson <sam@durosoft.com> Co-authored-by: Ben Greenberg <13892277+hummusonrails@users.noreply.github.com> * Update docs/DOCUMENTATION_GUIDELINES.md * Apply suggestions from code review Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> Co-authored-by: Ben Greenberg <13892277+hummusonrails@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ben Greenberg <13892277+hummusonrails@users.noreply.github.com> Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Apply suggestions from code review Co-authored-by: Sacha Lansky <sacha@parity.io> Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Further updates. * note about rewrap. * update ToC and more * update ToC and more * Update docs/DOCUMENTATION_GUIDELINES.md Co-authored-by: Sebastian Kunert <skunert49@gmail.com> * storage --------- Co-authored-by: Juan <juangirini@gmail.com> Co-authored-by: Ben Greenberg <13892277+hummusonrails@users.noreply.github.com> Co-authored-by: Sam Johnson <sam@durosoft.com> Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> Co-authored-by: Sacha Lansky <sacha@parity.io> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
This commit is contained in:
@@ -18,12 +18,11 @@ Before you submit, please check that:
|
||||
- [ ] Github project assignment
|
||||
- [ ] **Related Issues:** You mentioned a related issue if this PR is related to it, e.g. `Fixes #228` or `Related #1337`.
|
||||
- [ ] **2 Reviewers:** You asked at least two reviewers to review. If you aren't sure, start with GH suggestions.
|
||||
- [ ] **Style Guide:** Your PR adheres to [the style guide](https://github.com/paritytech/substrate/blob/master/docs/STYLE_GUIDE.md)
|
||||
- [ ] **Style Guide:** Your PR adheres to [the style guide](https://github.com/paritytech/substrate/blob/master/docs/STYLE_GUIDE.md).
|
||||
- In particular, mind the maximal line length of 100 (120 in exceptional circumstances).
|
||||
- There is no commented code checked in unless necessary.
|
||||
- Any panickers in the runtime have a proof or were removed.
|
||||
- [ ] **Runtime Version:** You bumped the runtime version if there are breaking changes in the **runtime**.
|
||||
- [ ] **Docs:** You updated any rustdocs which may need to change.
|
||||
- [ ] **Docs:** You updated any rustdocs which may need to change, as described [here](https://github.com/paritytech/substrate/blob/master/docs/DOCUMENTATION_GUIDELINES.md).
|
||||
- [ ] **Polkadot Companion:** Has the PR altered the external API or interfaces used by Polkadot?
|
||||
- [ ] If so, do you have the corresponding Polkadot PR ready?
|
||||
- [ ] Optionally: Do you have a corresponding Cumulus PR?
|
||||
|
||||
Reference in New Issue
Block a user