pezkuwichain
3680848df2
* docs: Add CLAUDE_RULES.md with strict rebrand protection rules - Define immutable rebrand rules that cannot be violated - Prohibit reverting rebrand for cargo check convenience - Establish checkpoint and audit trail requirements - Document correct error handling approach * refactor: Complete kurdistan-sdk to pezkuwi-sdk rebrand - Update README.md with pezkuwi-sdk branding - Replace all kurdistan-sdk URL references with pezkuwi-sdk - Replace kurdistan-tech with pezkuwichain in workflows - Update email domains from @kurdistan-tech.io to @pezkuwichain.io - Rename tool references: kurdistan-tech-publish → pezkuwi-publish - Update runner names: kurdistan-tech-* → pezkuwichain-* - Update analytics/forum/matrix domains to pezkuwichain.io - Keep 'Kurdistan Tech Institute' as organization name - Keep tech@kurdistan.gov as official government contact
21 lines
935 B
Markdown
21 lines
935 B
Markdown
# Markdown linting
|
|
|
|
Since the introduction of [PR #1309](https://github.com/pezkuwichain/pezkuwi-sdk/issues/103), the markdown
|
|
files in this repository are checked by a linter for formatting and consistency.
|
|
|
|
The linter used is [`markdownlint`](https://github.com/DavidAnson/markdownlint) and can be installed locally on your
|
|
machine. It can also be setup as [pre-commit hook](https://github.com/igorshubovych/markdownlint-cli#use-with-pre-commit)
|
|
to ensure that your markdown is passing all the tests.
|
|
|
|
The rules in place are defined
|
|
[here](https://github.com/pezkuwichain/pezkuwi-sdk/blob/master/.github/.markdownlint.yaml).
|
|
|
|
You may run `markdownlint` locally using:
|
|
```
|
|
markdownlint --config .github/.markdownlint.yaml --ignore target .
|
|
```
|
|
|
|
There are also plugins for your favorite editor, that can ensure that most
|
|
of the rules will pass and fix typical issues (such as trailing spaces,
|
|
missing eof new line, long lines, etc...)
|