mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-12 21:41:12 +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:
@@ -2,25 +2,27 @@
|
||||
|
||||
✄ -----------------------------------------------------------------------------
|
||||
|
||||
Thank you for your Pull Request! 🙏 Please make sure it follows the contribution
|
||||
guidelines outlined in [this document](https://github.com/paritytech/polkadot-sdk/blob/master/docs/CONTRIBUTING.md) and fill out the
|
||||
sections below. Once you're ready to submit your PR for review, please delete
|
||||
this section and leave only the text under the "Description" heading.
|
||||
|
||||
Thank you for your Pull Request! 🙏 Please make sure it follows the contribution guidelines outlined in
|
||||
[this document](https://github.com/paritytech/polkadot-sdk/blob/master/docs/CONTRIBUTING.md) and fill
|
||||
out the sections below. Once you're ready to submit your PR for review, please
|
||||
delete this section and leave only the text under the "Description" heading.
|
||||
|
||||
# Description
|
||||
|
||||
*Please include a summary of the changes and the related issue. Please also include relevant motivation and context, including:*
|
||||
*Please include a summary of the changes and the related issue. Please also include relevant motivation and context,
|
||||
including:*
|
||||
|
||||
- What does this PR do?
|
||||
- Why are these changes needed?
|
||||
- How were these changes implemented and what do they affect?
|
||||
|
||||
*Use [Github semantic linking](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to address any open issues this PR relates to or closes.*
|
||||
*Use [Github semantic
|
||||
linking](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
|
||||
to address any open issues this PR relates to or closes.*
|
||||
|
||||
Fixes # (issue number, *if applicable*)
|
||||
Fixes # (issue number, *if applicable*)
|
||||
|
||||
Closes # (issue number, *if applicable*)
|
||||
Closes # (issue number, *if applicable*)
|
||||
|
||||
Polkadot companion: (*if applicable*)
|
||||
|
||||
@@ -29,10 +31,12 @@ Cumulus companion: (*if applicable*)
|
||||
# Checklist
|
||||
|
||||
- [ ] My PR includes a detailed description as outlined in the "Description" section above
|
||||
- [ ] My PR follows the [labeling requirements](https://github.com/paritytech/polkadot-sdk/blob/master/docs/CONTRIBUTING.md#process) of this project (at minimum one label for `T` required)
|
||||
- [ ] My PR follows the [labeling requirements](CONTRIBUTING.md#Process) of this project (at minimum one label for `T`
|
||||
required)
|
||||
- [ ] I have made corresponding changes to the documentation (if applicable)
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable)
|
||||
- [ ] If this PR alters any external APIs or interfaces used by Polkadot, the corresponding Polkadot PR is ready as well as the corresponding Cumulus PR (optional)
|
||||
- [ ] If this PR alters any external APIs or interfaces used by Polkadot, the corresponding Polkadot PR is ready as well
|
||||
as the corresponding Cumulus PR (optional)
|
||||
|
||||
You can remove the "Checklist" section once all have been checked. Thank you for your contribution!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user