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

consistent mark-up first level bullet list

Browse Source 
An instance of `sed -i "s/^-/*/" CONTRIBUTING.markdown`.
This commit is contained in:
Norwid Behrnd 2022-11-30 14:04:36 +01:00
parent 21ad762462
commit 140b6da5cd
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.markdown
View File

@ -16,19 +16,19 @@ 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`
@ -47,31 +47,31 @@ some key information be defined in the header.
The following fields are necessary for English articles about programming The following fields are necessary for English articles about programming
languages: languages:
- **language** The *programming language* in question * **language** The *programming language* in question
- **contributors** A list of [author, URL] lists to credit * **contributors** A list of [author, URL] lists to credit
Other fields: Other fields:
- **category**: The category of the article. So far, can be one of *language*, * **category**: The category of the article. So far, can be one of *language*,
*tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted. *tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted.
- **filename**: The filename for this article's code. It will be fetched, mashed * **filename**: The filename for this article's code. It will be fetched, mashed
together, and made downloadable. together, and made downloadable.
+ For non-English articles, *filename* should have a language-specific + For non-English articles, *filename* should have a language-specific
suffix. suffix.
- **lang**: For translations, the human language this article is in. For * **lang**: For translations, the human language this article is in. For
categorization, mostly. categorization, mostly.
Here's an example header for an Esperanto translation of Ruby: Here's an example header for an Esperanto translation of Ruby:
```yaml ```yaml
--- *--
language: ruby language: ruby
filename: learnruby-epo.ruby filename: learnruby-epo.ruby
contributors: contributors:
- ["Doktor Esperanto", "http://example.com/"] - ["Doktor Esperanto", "http://example.com/"]
- ["Someone else", "http://someoneelseswebsite.com/"] - ["Someone else", "http://someoneelseswebsite.com/"]
lang: ep-ep lang: ep-ep
--- *--
``` ```
### Should I add myself as a Contributor? ### Should I add myself as a Contributor?