iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2024-12-23 17:41:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

use asterisk for second level bullet points

Browse Source 
Running `sed -i "s/^  +/   */" CONTRIBUTING.markdown`.  This is to
be complemented by a manual correction in the lower section, too.
This commit is contained in:
Norwid Behrnd 2022-11-30 14:07:56 +01:00
parent 140b6da5cd
commit fcc67f098b
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.markdown
View File

@ -17,23 +17,23 @@ review them more effectively and/or individually.
## Style Guidelines ## Style Guidelines
* **Keep lines under 80 chars** * **Keep lines under 80 chars**
+ Try to keep **line length in code blocks to 80 characters or fewer**. * Try to keep **line length in code blocks to 80 characters or fewer**.
+ Otherwise, the text will overflow and look odd. * Otherwise, the text will overflow and look odd.
* **Prefer example to exposition** * **Prefer example to exposition**
+ Try to use as few words as possible. * Try to use as few words as possible.
+ Code examples are preferred over exposition in all cases. * Code examples are preferred over exposition in all cases.
* **Eschew surplusage** * **Eschew surplusage**
+ We welcome newcomers, but the target audience for this site is programmers * We welcome newcomers, but the target audience for this site is programmers
with some experience. with some experience.
+ Try to avoid explaining basic concepts except for those specific to the * Try to avoid explaining basic concepts except for those specific to the
language in question. language in question.
+ Keep articles succinct and scannable. We all know how to use Google here. * Keep articles succinct and scannable. We all know how to use Google here.
* **Use UTF-8** * **Use UTF-8**
+ For translations (or EN articles with non-ASCII characters) please make sure * For translations (or EN articles with non-ASCII characters) please make sure
your file is UTF-8 encoded. your file is UTF-8 encoded.
+ Try to leave out the byte-order-mark at the start of the file. (`:set nobomb` * Try to leave out the byte-order-mark at the start of the file. (`:set nobomb`
in Vim) in Vim)
+ You can check if the file contains a BOM on Linux/Unix systems by running * You can check if the file contains a BOM on Linux/Unix systems by running
`file language.html.markdown` You will see this if it uses a BOM: `file language.html.markdown` You will see this if it uses a BOM:
`UTF-8 Unicode (with BOM) text`. `UTF-8 Unicode (with BOM) text`.