From 89b5d9277feac69286d9a7edc6d9718e8b321232 Mon Sep 17 00:00:00 2001 From: Boris Verkhovskiy Date: Wed, 18 Dec 2024 09:35:21 -0700 Subject: [PATCH] Update docs --- .github/PULL_REQUEST_TEMPLATE.md | 1 - CONTRIBUTING.md | 22 +++++++++------------- 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b730d6f3..23621150 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,4 +3,3 @@ - [ ] Pull request touches only one file (or a set of logically related files with similar changes made) - [ ] Content changes are aimed at *intermediate to experienced programmers* (this is a poor format for explaining fundamental programming concepts) - [ ] If you've changed any part of the YAML Frontmatter, make sure it is formatted according to [CONTRIBUTING.md](https://github.com/adambard/learnxinyminutes-docs/blob/master/CONTRIBUTING.md) - - [ ] Yes, I have double-checked quotes and field names! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d4d3b4e..e501a91a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,13 +31,6 @@ review them more effectively and/or individually. language in question. * Keep articles succinct and scannable. We all know how to use Google here. * **Use UTF-8** - * For translations (or EN articles with non-ASCII characters) please ensure - your file is UTF-8 encoded. - * Leave out the byte-order-mark (BOM) at the start of the file (in Vim, use - `:set nobomb`). - * 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: - `UTF-8 Unicode (with BOM) text`. ### Header configuration @@ -48,29 +41,32 @@ called frontmatter. The following fields are necessary for English articles about programming languages: -* **name** The human-readable name of the programming language -* **contributors** A list of [author, URL] lists to credit +* `name`: The human-readable name of the programming language +* `contributors`: A list of [*author*, *URL*] lists to credit, *URL* is optional 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. -* **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. +Translations should also include: +* `translators`: A list of [*translator*, *URL*] lists to credit, *URL* is optional + Non-English articles inherit frontmatter values from the English article (if it exists) but you can overwrite them. Here's an example header for Ruby: ```yaml -*-- +--- name: Ruby filename: learnruby.rb contributors: - ["Doktor Esperanto", "http://example.com/"] - ["Someone else", "http://someoneelseswebsite.com/"] -*-- +--- ``` ### Syntax highlighter