Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(contributing): Add minimal standard for contributing documentation #429

Merged
merged 1 commit into from
Oct 3, 2024
Merged

docs(contributing): Add minimal standard for contributing documentation #429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,17 @@ Our custom set of rules is in [commitlint.config.js](./commitlint.config.js).

Generally the description of a commit should start with a verb in the imperative voice, so that it would properly complete the sentence: "When applied, this commit will [...]".

### Contributing documentation

When writing documentation, whether it be online, docstrings or help messages in the CLI and in the UI, we strive to follow some conventions that are listed below. These might be updated as time goes on.

1. Argument descriptions should be written so that the following sentence makes sense: `Argument <argument> designates <argument description>`
1. Argument descriptions start with lower case, and do not end with a period or other punctuation
2. Argument descriptions start with "the" where relevant, and "whether" for booleans
2. Text is written in US english ("visualize" rather than "visualise")
3. In the CLI, positional arguments are written in snake case (`snake_case`), keyword arguments in kebab case (`kebab-case`)
4. When there is a default argument, it should be shown in the help message, typically with `(default: <default value>)` at the end of the message

## Help for common issues

### `make build-frontend` doesn't work!
Expand Down