Skip to content

Commit 8fcebd0

Browse files
kzndotshkzndotsh
committed
docs(CODE_OF_CONDUCT.md, CONTRIBUTING.md): wrap email and URLs in angle brackets for better markdown rendering
refactor(CONTRIBUTING.md): improve document structure and readability by adding indentation and spacing style(CONTRIBUTING.md): add newline at end of file to adhere to POSIX standards feat: add .markdownlint.yaml for consistent markdown formatting This commit adds a .markdownlint.yaml configuration file to enforce consistent markdown formatting across the project. This will help maintain readability and uniformity in all markdown files. docs: improve readability and clarity of project documentation - README.md: Simplify title and subtitle formatting, add warning about bot readiness, clarify installation steps, and improve overall readability. - cli.md: Improve readability by adding line breaks. - commands.md: Remove unnecessary line break. - development.md: Simplify introduction, refer to README for installation instructions, and improve readability. - permissions.md: Improve readability by adding line breaks and clarifying permission levels. style(services.md): improve readability by adding a line break between two sentences docs(services.md): add newline at end of file to adhere to POSIX standards
1 parent 1bf1642 commit 8fcebd0

9 files changed

+379
-64
lines changed

‎.github/CODE_OF_CONDUCT.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
[email protected].
63+
<mailto:[email protected]>.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120120

121121
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122122
enforcement ladder](https://github.com/mozilla/diversity).
123123

124124
[homepage]: https://www.contributor-covenant.org
125125

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

‎.github/CONTRIBUTING.md

+22-15
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,56 @@
11
# Contributing to Tux 🐧
22

33
## Topics
4-
- [Contributing Flow](#contributing-flow)
5-
- [Issues](#issues)
6-
- [Branch Naming Conventions](#branch-naming-conventions)
4+
5+
- [Contributing to Tux 🐧](#contributing-to-tux-)
6+
- [Topics](#topics)
7+
- [Contributing Flow](#contributing-flow)
8+
- [Issues](#issues)
9+
- [Branch Naming Conventions](#branch-naming-conventions)
710

811
## Contributing Flow
12+
913
1. See [Issues](#issues) topic.
1014
2. Fork the project.
1115
3. Create a new branch (please, see [Branch Naming Conventions](#branch-naming-conventions) topic if you don't know our conventions).
1216

13-
1417
4. After done with modifications, time to commit and push. Example:
1518

16-
```
17-
git add tux/help.py
18-
git commit -m "feat(tux): add help command" -m "Help command description"
19-
git push origin feat/add-help-command
20-
```
19+
```bash
20+
git add tux/help.py
21+
git commit -m "feat(tux): add help command" -m "Help command description"
22+
git push origin feat/add-help-command
23+
```
2124

2225
5. Send a Pull Request (PR) with the modifications, referencing the `main` branch.
2326
6. Your contribution will be reviewed by the maintainers.
2427

25-
2628
After merge:
29+
2730
- Delete the branch used to commit:
28-
```
31+
32+
```bash
2933
git checkout main
3034
git push origin --delete feat/add-help-command
3135
git branch -D feat/add-help-command
3236
```
3337

3438
- Update your fork:
35-
```
39+
40+
```bash
3641
git remote add upstream https://github.com/allthingslinux/tux.git
3742
git fetch upstream
3843
git rebase upstream/main
3944
git push -f origin main
4045
```
4146

4247
## Issues
43-
Before submitting a large PR, please open an [issue](https://github.com/allthingslinux/tux/issues/new) so we can discuss the idea.
4448

45-
## Branch Naming Conventions
49+
Before submitting a large PR, please open an [issue](https://github.com/allthingslinux/tux/issues/new) so we can discuss the idea.
50+
51+
## Branch Naming Conventions
52+
4653
- Documentation: `git checkout -b docs/contributing`
4754
- Modifications: `git checkout -b chore/update-dependencies`
4855
- Features: `git checkout -b feat/add-help-command`
49-
- Fixing: `git checkout -b fix/help-command`
56+
- Fixing: `git checkout -b fix/help-command`

‎.markdownlint.yaml

+266
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
# Example markdownlint configuration with all properties set to their default value
2+
3+
# Default state for all rules
4+
default: true
5+
6+
# Path to configuration file to extend
7+
extends: null
8+
9+
# MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md001.md
10+
MD001: true
11+
12+
# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md003.md
13+
MD003:
14+
# Heading style
15+
style: "consistent"
16+
17+
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md
18+
MD004:
19+
# List style
20+
style: "consistent"
21+
22+
# MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md005.md
23+
MD005: true
24+
25+
# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md
26+
MD007:
27+
# Spaces for indent
28+
indent: 2
29+
# Whether to indent the first level of the list
30+
start_indented: false
31+
# Spaces for first level indent (when start_indented is set)
32+
start_indent: 2
33+
34+
# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md
35+
MD009:
36+
# Spaces for line break
37+
br_spaces: 2
38+
# Allow spaces for empty lines in list items
39+
list_item_empty_lines: false
40+
# Include unnecessary breaks
41+
strict: false
42+
43+
# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md010.md
44+
MD010:
45+
# Include code blocks
46+
code_blocks: true
47+
# Fenced code languages to ignore
48+
ignore_code_languages: []
49+
# Number of spaces for each hard tab
50+
spaces_per_tab: 1
51+
52+
# MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md011.md
53+
MD011: true
54+
55+
# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md
56+
MD012:
57+
# Consecutive blank lines
58+
maximum: 1
59+
60+
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
61+
MD013:
62+
# Number of characters
63+
line_length: 200
64+
# Number of characters for headings
65+
heading_line_length: 80
66+
# Number of characters for code blocks
67+
code_block_line_length: 80
68+
# Include code blocks
69+
code_blocks: true
70+
# Include tables
71+
tables: true
72+
# Include headings
73+
headings: true
74+
# Strict length checking
75+
strict: false
76+
# Stern length checking
77+
stern: false
78+
79+
# MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md014.md
80+
MD014: true
81+
82+
# MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md018.md
83+
MD018: true
84+
85+
# MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md019.md
86+
MD019: true
87+
88+
# MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md020.md
89+
MD020: true
90+
91+
# MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md021.md
92+
MD021: true
93+
94+
# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md
95+
MD022:
96+
# Blank lines above heading
97+
lines_above: 1
98+
# Blank lines below heading
99+
lines_below: 1
100+
101+
# MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md023.md
102+
MD023: true
103+
104+
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md
105+
MD024:
106+
# Only check sibling headings
107+
siblings_only: false
108+
109+
# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md
110+
MD025:
111+
# Heading level
112+
level: 1
113+
# RegExp for matching title in front matter
114+
front_matter_title: "^\\s*title\\s*[:=]"
115+
116+
# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md026.md
117+
MD026:
118+
# Punctuation characters
119+
punctuation: ".,;:!。，；：！"
120+
121+
# MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md027.md
122+
MD027: true
123+
124+
# MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md
125+
MD028: false
126+
127+
# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md029.md
128+
MD029:
129+
# List style
130+
style: "one_or_ordered"
131+
132+
# MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md030.md
133+
MD030:
134+
# Spaces for single-line unordered list items
135+
ul_single: 1
136+
# Spaces for single-line ordered list items
137+
ol_single: 1
138+
# Spaces for multi-line unordered list items
139+
ul_multi: 1
140+
# Spaces for multi-line ordered list items
141+
ol_multi: 1
142+
143+
# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
144+
MD031:
145+
# Include list items
146+
list_items: true
147+
148+
# MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
149+
MD032: true
150+
151+
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
152+
MD033: false
153+
154+
# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md034.md
155+
MD034: true
156+
157+
# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md035.md
158+
MD035:
159+
# Horizontal rule style
160+
style: "consistent"
161+
162+
# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md036.md
163+
MD036:
164+
# Punctuation characters
165+
punctuation: ".,;:!?。，；：！？"
166+
167+
# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md037.md
168+
MD037: true
169+
170+
# MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md038.md
171+
MD038: true
172+
173+
# MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md039.md
174+
MD039: true
175+
176+
# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md040.md
177+
MD040:
178+
# List of languages
179+
allowed_languages: []
180+
# Require language only
181+
language_only: false
182+
183+
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md
184+
MD041:
185+
# Heading level
186+
level: 1
187+
# RegExp for matching title in front matter
188+
front_matter_title: "^\\s*title\\s*[:=]"
189+
190+
# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md042.md
191+
MD042: true
192+
193+
# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md043.md
194+
MD043: false
195+
196+
# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md044.md
197+
MD044:
198+
# List of proper names
199+
names: []
200+
# Include code blocks
201+
code_blocks: true
202+
# Include HTML elements
203+
html_elements: true
204+
205+
# MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md045.md
206+
MD045: true
207+
208+
# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md
209+
MD046:
210+
# Block style
211+
style: "consistent"
212+
213+
# MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md
214+
MD047: true
215+
216+
# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md048.md
217+
MD048:
218+
# Code fence style
219+
style: "consistent"
220+
221+
# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md
222+
MD049:
223+
# Emphasis style
224+
style: "consistent"
225+
226+
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md050.md
227+
MD050:
228+
# Strong style
229+
style: "consistent"
230+
231+
# MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md051.md
232+
MD051: true
233+
234+
# MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md052.md
235+
MD052:
236+
# Include shortcut syntax
237+
shortcut_syntax: false
238+
239+
# MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md053.md
240+
MD053:
241+
# Ignored definitions
242+
ignored_definitions:
243+
- "//"
244+
245+
# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md054.md
246+
MD054:
247+
# Allow autolinks
248+
autolink: true
249+
# Allow inline links and images
250+
inline: true
251+
# Allow full reference links and images
252+
full: true
253+
# Allow collapsed reference links and images
254+
collapsed: true
255+
# Allow shortcut reference links and images
256+
shortcut: true
257+
# Allow URLs as inline links
258+
url_inline: true
259+
260+
# MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md
261+
MD055:
262+
# Table pipe style
263+
style: "consistent"
264+
265+
# MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
266+
MD056: true

0 commit comments

Comments
 (0)