Skip to content
This repository was archived by the owner on Feb 18, 2025. It is now read-only.

Commit 9a68f7d

Browse files
WollacWollac
authored
Chore: Markdown Linting (#47)
* Check if all files end in newline * Fix action path * Use markdownlint * Update markdownlint.yml * Create markdownlint-config.yml * add newline to end of tips * Update markdownlint.yml * Only lint TIPs * Update markdownlint.yml * add newline to end of template
1 parent e8e954c commit 9a68f7d

File tree

14 files changed

+34
-12
lines changed

14 files changed

+34
-12
lines changed

‎.github/markdownlint-config.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
default: false # excludes all rules by default
2+
3+
# Files should end with a single newline character <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047>
4+
MD047: true

‎.github/workflows/markdownlint.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Markdown Lint
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
7+
8+
jobs:
9+
lint:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v2
14+
- name: Markdown Linting
15+
uses: avto-dev/[email protected]
16+
with:
17+
config: './.github/markdownlint-config.yml'
18+
args: './tips/**/*.md'

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ You may find more information about the TIP Process in [TIP-1](./tips/TIP-0001/t
4141

4242
## Need help?
4343

44-
If you want to get involved in the community, need help getting started, have any issues related to the repository or just want to discuss blockchain, distributed ledgers, and IoT with other people, feel free to join our [Discord](https://discord.iota.org/).
44+
If you want to get involved in the community, need help getting started, have any issues related to the repository or just want to discuss blockchain, distributed ledgers, and IoT with other people, feel free to join our [Discord](https://discord.iota.org/).

‎tip-template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ Test cases for an implementation are mandatory for TIPs that are affecting conse
4343
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in the TIPs directory.
4444

4545
## Copyright
46-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
46+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0001/tip-0001.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -225,4 +225,4 @@ In order not to reinvent the wheel, the TIP Process draws heavily on the [BIP](h
225225

226226
## Copyright
227227

228-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
228+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0003/tip-0003.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,4 @@ Since different tips indirectly reference the same transactions, this computatio
162162

163163
# Copyright
164164

165-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
165+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0004/tip-0004.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,4 +131,4 @@ Example Go implementation in [wollac/iota-crypto-demo](https://github.com/Wollac
131131

132132
# Copyright
133133

134-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
134+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0006/tip-0006.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@ This approach seems less extensible. It might have made sense if we had wanted t
198198

199199
# Copyright
200200

201-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
201+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0009/tip-0009.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -428,4 +428,4 @@ Nodes need to support this new format.
428428

429429
# Copyright
430430

431-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
431+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0010/tip-0010.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ Example Go implementation in [wollac/iota-crypto-demo](https://github.com/Wollac
7474

7575
# Copyright
7676

77-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
77+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0012/tip-0012.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ Example Go implementation in [wollac/iota-crypto-demo](https://github.com/Wollac
7474

7575
# Copyright
7676

77-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
77+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0013/tip-0013.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ The API is described using the OpenAPI Specification:
2222

2323
# Copyright
2424

25-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
25+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0015/tip-0015.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@ The second option is much more complicated as it introduces a completely new unl
129129

130130
# Copyright
131131

132-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
132+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

‎tips/TIP-0016/tip-0016.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ The API is described using the AsyncAPI Specification:
2222

2323
# Copyright
2424

25-
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
25+
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

0 commit comments

Comments
 (0)