From 6bf21747396448363e4a95f933d6c802189d082d Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Thu, 15 Oct 2020 17:10:55 +0100 Subject: [PATCH 1/7] Add Style Guide --- STYLE-GUIDE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 STYLE-GUIDE.md diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md new file mode 100644 index 0000000000..ef78e39429 --- /dev/null +++ b/STYLE-GUIDE.md @@ -0,0 +1,22 @@ +# Exercism's Style Guide + +This document acts as a Style Guide for the language and wording used in exercises. + +## General principle + +All content should be written in US english. +In the future other translations may occur, but the "official" Exercism natural langauge is US English. + +## Explain or substitude mathmatical and esotoric terms. + +In any place that mathematical terms are used they should be explained or substituted out for terms that require less domain knowledge. + +Examples: +- Rather than using "natural numbers", we should use "positive integers" or "zero and positive integers". +- If we want to use the phrase "rational numbers", it must be explained in the introduction to the exercise. +- Rather than using the word range (which can have different meanings in different contexts) use "greater than x and less than y". + +## Use consistency within an exercise. + +There are some terms that have multiple valid spellings (e.g. "lower case" vs "lowercase"). +Where a consistent style has not been agreed within this document, these must be consistent within an exercise. From fd860b35663e0d0359a17cb482a320987214ed3b Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Thu, 15 Oct 2020 18:01:47 +0100 Subject: [PATCH 2/7] Update STYLE-GUIDE.md Co-authored-by: Sascha Mann --- STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index ef78e39429..1af0443ec5 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -7,7 +7,7 @@ This document acts as a Style Guide for the language and wording used in exercis All content should be written in US english. In the future other translations may occur, but the "official" Exercism natural langauge is US English. -## Explain or substitude mathmatical and esotoric terms. +## Explain or substitude mathematical and esotoric terms. In any place that mathematical terms are used they should be explained or substituted out for terms that require less domain knowledge. From 5e956070ef8fc11d77bcccc4eb089d943d5067fa Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Thu, 15 Oct 2020 18:01:55 +0100 Subject: [PATCH 3/7] Update STYLE-GUIDE.md Co-authored-by: Sascha Mann --- STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 1af0443ec5..8023643658 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -5,7 +5,7 @@ This document acts as a Style Guide for the language and wording used in exercis ## General principle All content should be written in US english. -In the future other translations may occur, but the "official" Exercism natural langauge is US English. +In the future other translations may occur, but the "official" Exercism language is US English. ## Explain or substitude mathematical and esotoric terms. From 9d6034e869335ffb7f73cb5267818c0bca084814 Mon Sep 17 00:00:00 2001 From: Colin Caine Date: Thu, 15 Oct 2020 18:17:03 +0100 Subject: [PATCH 4/7] Update STYLE-GUIDE.md Co-authored-by: Ryan Potts --- STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 8023643658..38c897ab39 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -7,7 +7,7 @@ This document acts as a Style Guide for the language and wording used in exercis All content should be written in US english. In the future other translations may occur, but the "official" Exercism language is US English. -## Explain or substitude mathematical and esotoric terms. +## Explain or substitute mathematical and esoteric terms. In any place that mathematical terms are used they should be explained or substituted out for terms that require less domain knowledge. From 2bb8c22dd346fc8a57571a69ae37c18d4bbc5b7c Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Thu, 15 Oct 2020 18:21:07 +0100 Subject: [PATCH 5/7] Update STYLE-GUIDE.md Co-authored-by: Sascha Mann --- STYLE-GUIDE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 38c897ab39..f7778ba7e2 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -4,7 +4,8 @@ This document acts as a Style Guide for the language and wording used in exercis ## General principle -All content should be written in US english. +All content should be written in US English. +All units of measurement must be [SI](https://en.wikipedia.org/wiki/International_System_of_Units) or [SI-derived](https://en.wikipedia.org/wiki/SI_derived_unit) units. In the future other translations may occur, but the "official" Exercism language is US English. ## Explain or substitute mathematical and esoteric terms. From ce63702cf2a7991a0ce165222af63b2e93de04bc Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Thu, 15 Oct 2020 20:44:12 +0100 Subject: [PATCH 6/7] Update STYLE-GUIDE.md --- STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index f7778ba7e2..5ceeafb70f 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -13,7 +13,7 @@ In the future other translations may occur, but the "official" Exercism language In any place that mathematical terms are used they should be explained or substituted out for terms that require less domain knowledge. Examples: -- Rather than using "natural numbers", we should use "positive integers" or "zero and positive integers". +- Rather than using "natural numbers", we should use "positive whole numbers". - If we want to use the phrase "rational numbers", it must be explained in the introduction to the exercise. - Rather than using the word range (which can have different meanings in different contexts) use "greater than x and less than y". From b90aab0af9c64eedc042da3fa8644019223a72d3 Mon Sep 17 00:00:00 2001 From: Jeremy Walker Date: Thu, 15 Oct 2020 20:44:59 +0100 Subject: [PATCH 7/7] Update STYLE-GUIDE.md --- STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 5ceeafb70f..96180170da 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -15,7 +15,7 @@ In any place that mathematical terms are used they should be explained or substi Examples: - Rather than using "natural numbers", we should use "positive whole numbers". - If we want to use the phrase "rational numbers", it must be explained in the introduction to the exercise. -- Rather than using the word range (which can have different meanings in different contexts) use "greater than x and less than y". +- Rather than using the word range (which can have different meanings in different contexts) use "x < ? < y (greater than x and less than y)". ## Use consistency within an exercise.