mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 02:21:14 +00:00
Markdown linter (#1309)
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
This commit is contained in:
@@ -32,11 +32,11 @@ If it is an urgent fix with no large change to logic, then it may be merged afte
|
||||
contributor has reviewed it well and approved the review once CI is complete.
|
||||
No PR should be merged until all reviews' comments are addressed.
|
||||
|
||||
### Labels:
|
||||
### Labels
|
||||
|
||||
The set of labels and their description can be found [here](https://paritytech.github.io/labels/doc_polkadot-sdk.html).
|
||||
|
||||
### Process:
|
||||
### Process
|
||||
|
||||
1. Please use our [Pull Request Template](./PULL_REQUEST_TEMPLATE.md) and make sure all relevant
|
||||
information is reflected in your PR.
|
||||
@@ -50,12 +50,12 @@ The set of labels and their description can be found [here](https://paritytech.g
|
||||
`T13-documentation`. The docs team will get in touch.
|
||||
5. If your PR changes files in these paths:
|
||||
|
||||
`polkadot` : '^runtime/polkadot'
|
||||
`polkadot` : '^runtime/kusama'
|
||||
`polkadot` : '^primitives/src/'
|
||||
`polkadot` : '^runtime/common'
|
||||
`substrate` : '^frame/'
|
||||
`substrate` : '^primitives/'
|
||||
`polkadot` : `^runtime/polkadot`
|
||||
`polkadot` : `^runtime/kusama`
|
||||
`polkadot` : `^primitives/src/`
|
||||
`polkadot` : `^runtime/common`
|
||||
`substrate` : `^frame/`
|
||||
`substrate` : `^primitives/`
|
||||
|
||||
It should be added to the [security audit board](https://github.com/orgs/paritytech/projects/103)
|
||||
and will need to undergo an audit before merge.
|
||||
@@ -67,7 +67,7 @@ to change the code to make it work/compile.
|
||||
It should also mention potential storage migrations and if they require some special setup aside adding
|
||||
it to the list of migrations in the runtime.
|
||||
|
||||
## Reviewing pull requests:
|
||||
## Reviewing pull requests
|
||||
|
||||
When reviewing a pull request, the end-goal is to suggest useful changes to the author.
|
||||
Reviews should finish with approval unless there are issues that would result in:
|
||||
|
||||
Reference in New Issue
Block a user