By contributing,
- you agree to have your contribution distributed under the CC BY-NC-SA 4.0 license;
- you swear to have ownership over the content and are able to share it under the aforementioned license;
What to contribute
There are many things to contribute here, here is a non exhaustive list:
- Add, update, translate
X
- Add, update, translate
Y
- Add, update, translate
X in Y
- Add missing translation
- Fix typo
- Improve code
- Improve prose
- Fix any of the
TODO
Guidelines
Contributing X
X
s are simple tasks to perform, they must do one thing and one thing only.
For instance, filter and sort matching string prefix
can be broken down in
three X
s:
filter an array
sort an array
match a string prefix
Adding a new X
means writing its definition.
The definition gives the X
its title, file pattern,
Glossary#aka
.
See examples.
The definition must always be added first in the en
language. This is
how linking with other languages work. See
Glossary#cascade
.
The file path should follow Hugo’s taxonomy doc.
file pattern
<what>_[what_]+<action>
The
what
s go from most general, to less general.Examples:
- ✅
string_prefix_match
- ❌
match_string_prefix
- ❌
string_prefix_match
The logic here is to have common types in nearby files. This doesn’t impact how it renders, this is purely file organization.
- ✅
title
Those are displayed to the user, and must be matching the following sentence:
In order to <title>, I must ...
The title must not start with an uppercase letter.
Examples:
- ✅
match a string prefix
- ❌
to match the prefix of a string
- ❌
How to match the string prefix
- ✅
aka
They should follow the same rules as
title
, but can be more free in their writing.content
The content gives additional details on the
X
. Its usefulness, its edge-cases, etc.It must also set the fixed parameters for the examples. This ensures that all code have a limited amount of differences.
Example:
Matching a string prefix means checking if the string starts by a specified content. Examples: - `a great day` start with `a great` - `a pretty night` does not start with `a great`
references
Additional links that can help set the context and history of an
X
.
Contributing Y
A Y
is a programming language, a tool, etc.
It must be without external dependencies. For instance, in a programming language, consider only the standard library.
If external dependencies are used, they should be in addition to a standard library example.
Example: most seach results for “http request python” link to the awesome Requests library, but it’s possible
Contributing X in Y
TODO