Skip to content

Commit ec70390

Browse files
Linted all MD files, enabled MD linter for each commit
1 parent 6ef01d9 commit ec70390

20 files changed

+589
-482
lines changed

.github/workflows/checks.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ jobs:
1919
run: |
2020
npm install
2121
22-
#- name: Linting markdown
23-
# if: always()
24-
# run: |
25-
# npm run-script markdownlint
22+
- name: Linting markdown
23+
if: always()
24+
run: |
25+
npm run-script markdownlint
2626
2727
- name: Checking for broken links
2828
if: always()

.markdownlint.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{
22
"default": true,
33
"MD013": false,
4+
"MD026": false,
5+
"MD024": {
6+
"allow_different_nesting": true
7+
},
48
"MD033": {
59
"allowed_elements": [
610
"a",
@@ -9,6 +13,7 @@
913
"code",
1014
"em",
1115
"hr",
16+
"img",
1217
"li",
1318
"ol",
1419
"p",
@@ -24,5 +29,6 @@
2429
"ul"
2530
]
2631
},
27-
"MD034": false
32+
"MD034": false,
33+
"MD036": false
2834
}

.spelling

+13-13
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ blacklist
1414
broadcasted
1515
Bundesbeauftragter
1616
Bundesnetzagentur
17-
Changelog
18-
Changelogs
1917
changelog
18+
Changelog
2019
changelogs
20+
Changelogs
2121
Checkmarx
22-
Commonmark
2322
commonmark
23+
Commonmark
2424
config
2525
Config
2626
coronavirus
@@ -33,8 +33,8 @@ cwa-verification-iam
3333
cwa-verification-portal
3434
cwa-verification-server
3535
CxSAST
36-
Cyber
3736
cyber
37+
Cyber
3838
DDoS
3939
deanonymize
4040
Deutsche
@@ -55,21 +55,21 @@ Informationsfreiheit
5555
Infrastrukturen
5656
iOS
5757
Kritische
58+
lifecycle
59+
Lifecycle
5860
linter
5961
linters
60-
Lifecycle
61-
lifecycle
6262
logfile
6363
logfiles
6464
macOS
6565
markdownlint.json
66-
Metadata
6766
metadata
67+
Metadata
6868
misconfiguration
6969
natively
7070
npm
71-
Onboarding
7271
onboarding
72+
Onboarding
7373
package.json
7474
PEPP-PT
7575
PostgreSQL
@@ -96,28 +96,28 @@ TalkBack
9696
TEK
9797
TEKs
9898
Telekom
99-
TeleTAN
100-
TeleTANs
10199
teleTAN
100+
TeleTAN
102101
teleTANs
102+
TeleTANs
103103
timeframe
104104
timestamp
105105
timestamping
106106
Timestamping
107-
tl;dr
108107
tl
108+
tl;dr
109109
Tx
110110
UI
111111
uninstallation
112112
Uninstallation
113113
unlinkability
114114
Unlinkability
115-
Unobservability
116115
unobservability
116+
Unobservability
117117
unsecure
118118
up-to-dateness
119119
useable
120120
versioning
121121
Vulas
122122
whitelist
123-
WhiteSource
123+
WhiteSource

CODE_OF_CONDUCT.md

+25-75
Original file line numberDiff line numberDiff line change
@@ -3,128 +3,78 @@
33

44
## Our Pledge
55

6-
We as members, contributors, and leaders pledge to make participation in our
7-
community a harassment-free experience for everyone, regardless of age, body
8-
size, visible or invisible disability, ethnicity, sex characteristics, gender
9-
identity and expression, level of experience, education, socio-economic status,
10-
nationality, personal appearance, race, religion, or sexual identity
11-
and orientation.
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
127

13-
We pledge to act and interact in ways that contribute to an open, welcoming,
14-
diverse, inclusive, and healthy community.
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
159

1610
## Our Standards
1711

18-
Examples of behavior that contributes to a positive environment for our
19-
community include:
12+
Examples of behavior that contributes to a positive environment for our community include:
2013

2114
* Demonstrating empathy and kindness toward other people
2215
* Being respectful of differing opinions, viewpoints, and experiences
2316
* Giving and gracefully accepting constructive feedback
24-
* Accepting responsibility and apologizing to those affected by our mistakes,
25-
and learning from the experience
26-
* Focusing on what is best not just for us as individuals, but for the
27-
overall community
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
2819

2920
Examples of unacceptable behavior include:
3021

31-
* The use of sexualized language or imagery, and sexual attention or
32-
advances of any kind
22+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
3323
* Trolling, insulting or derogatory comments, and personal or political attacks
3424
* Public or private harassment
35-
* Publishing others' private information, such as a physical or email
36-
address, without their explicit permission
37-
* Other conduct which could reasonably be considered inappropriate in a
38-
professional setting
25+
* Publishing others' private information, such as a physical or email address, without their explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
3927

4028
## Enforcement Responsibilities
4129

42-
Community leaders are responsible for clarifying and enforcing our standards of
43-
acceptable behavior and will take appropriate and fair corrective action in
44-
response to any behavior that they deem inappropriate, threatening, offensive,
45-
or harmful.
30+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
4631

47-
Community leaders have the right and responsibility to remove, edit, or reject
48-
comments, commits, code, wiki edits, issues, and other contributions that are
49-
not aligned to this Code of Conduct, and will communicate reasons for moderation
50-
decisions when appropriate.
32+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
5133

5234
## Scope
5335

54-
This Code of Conduct applies within all community spaces, and also applies when
55-
an individual is officially representing the community in public spaces.
56-
Examples of representing our community include using an official e-mail address,
57-
posting via an official social media account, or acting as an appointed
58-
representative at an online or offline event.
36+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
5937

6038
## Enforcement
6139

62-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63-
reported to the community leaders responsible for enforcement at
64-
65-
All complaints will be reviewed and investigated promptly and fairly.
40+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
6641

67-
All community leaders are obligated to respect the privacy and security of the
68-
reporter of any incident.
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
6943

7044
## Enforcement Guidelines
7145

72-
Community leaders will follow these Community Impact Guidelines in determining
73-
the consequences for any action they deem in violation of this Code of Conduct:
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
7447

7548
### 1. Correction
7649

77-
**Community Impact**: Use of inappropriate language or other behavior deemed
78-
unprofessional or unwelcome in the community.
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
7951

80-
**Consequence**: A private, written warning from community leaders, providing
81-
clarity around the nature of the violation and an explanation of why the
82-
behavior was inappropriate. A public apology may be requested.
52+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
8353

8454
### 2. Warning
8555

86-
**Community Impact**: A violation through a single incident or series
87-
of actions.
56+
**Community Impact**: A violation through a single incident or series of actions.
8857

89-
**Consequence**: A warning with consequences for continued behavior. No
90-
interaction with the people involved, including unsolicited interaction with
91-
those enforcing the Code of Conduct, for a specified period of time. This
92-
includes avoiding interactions in community spaces as well as external channels
93-
like social media. Violating these terms may lead to a temporary or
94-
permanent ban.
58+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
9559

9660
### 3. Temporary Ban
9761

98-
**Community Impact**: A serious violation of community standards, including
99-
sustained inappropriate behavior.
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
10063

101-
**Consequence**: A temporary ban from any sort of interaction or public
102-
communication with the community for a specified period of time. No public or
103-
private interaction with the people involved, including unsolicited interaction
104-
with those enforcing the Code of Conduct, is allowed during this period.
105-
Violating these terms may lead to a permanent ban.
64+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
10665

10766
### 4. Permanent Ban
10867

109-
**Community Impact**: Demonstrating a pattern of violation of community
110-
standards, including sustained inappropriate behavior, harassment of an
111-
individual, or aggression toward or disparagement of classes of individuals.
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
11269

113-
**Consequence**: A permanent ban from any sort of public interaction within
114-
the community.
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
11571

11672
## Attribution
11773

118-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119-
version 2.0, available at
120-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
12175

122-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123-
enforcement ladder](https://github.com/mozilla/diversity).
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
12477

12578
[homepage]: https://www.contributor-covenant.org
12679

127-
For answers to common questions about this code of conduct, see the FAQ at
128-
https://www.contributor-covenant.org/faq. Translations are available at
129-
https://www.contributor-covenant.org/translations.
130-
80+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ All members of the project community must abide by the [Contributor Covenant, ve
1010
Only by respecting each other we can develop a productive, collaborative community.
1111
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [[email protected]](mailto:[email protected]) and/or a project maintainer.
1212

13-
We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers.
13+
We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers.
1414

1515
## Engaging in Our Project
1616

INSTALL.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Every individual check can be run like so:
5757
```shell
5858
npm runscript my-individual-check
5959
```
60+
6061
See the package.json file for help.
6162

6263
#### Markdown linter
@@ -67,7 +68,7 @@ Markdown linting. See the rules [here](https://github.com/DavidAnson/markdownlin
6768
npm run-script markdownlint
6869
```
6970

70-
##### Overrides
71+
##### Markdown linter overrides
7172

7273
Sometimes it is not possible to be commonmark conform. In this rare cases an inline tag to skip linting is possible.
7374

@@ -80,9 +81,11 @@ Candidates are tables.
8081
<!-- markdownlint-enable-->
8182
```
8283

83-
Additionally HTML image tags can be allowed globally. This is useful if you need to resize images, since commonmark has no annotation for this.
84+
Additionally HTML image tags can be allowed globally. This is useful if you need
85+
to resize images, since commonmark has no annotation for this.
8486

85-
This is done with a .markdownlint.json override file which would look something like this:
87+
This is done with a .markdownlint.json override file which would look something
88+
like this:
8689

8790
```json
8891
{
@@ -95,7 +98,8 @@ This is done with a .markdownlint.json override file which would look something
9598
}
9699
```
97100

98-
For more information how to tweak overrides consult the markdown linter documentation mentioned above.
101+
For more information how to tweak overrides consult the markdown linter
102+
documentation mentioned above.
99103

100104
#### Spell checker
101105

@@ -111,15 +115,17 @@ npm run-script spellcheck
111115

112116
Not implemented yet.
113117

114-
##### Overrides
118+
##### Spell checker overrides
115119

116-
Add any additional words to the .spelling file and use the target to sort and clean them before adding these to master.
120+
Add any additional words to the .spelling file and use the target to sort and
121+
clean them before adding these to master.
117122

118123
```shell
119124
npm run-script format-spelling
120125
```
121126

122-
Please note sometimes overriding is not the way to go. Our terminology should be applied consistently.
127+
Please note sometimes overriding is not the way to go. Our terminology should be
128+
applied consistently.
123129

124130
#### Link resolver
125131

@@ -131,7 +137,8 @@ npm run-script checklinks
131137

132138
#### Inconsiderate language scanner
133139

134-
This checks against profanity and inconsiderate language. This is help full for non-natives to detect words that could be inconsiderate. This utilizes [alex](https://github.com/get-alex/alex)
140+
This checks against profanity and inconsiderate language. This is help full for
141+
non-natives to detect words that could be inconsiderate. This utilizes [alex](https://github.com/get-alex/alex)
135142

136143
```shell
137144
npm run-script detect-inconsiderate-language

0 commit comments

Comments
 (0)