Skip to content

Commit

Permalink
docs: add style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
themighty1 committed Jan 16, 2024
1 parent 3c82a1a commit 24cc9b4
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,35 @@ depending on the types of changes defined by
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

If the required subsection does not exist yet under **Unreleased**, create it!
If the required subsection does not exist yet under **Unreleased**, create it!

## Style

### Capitalization and punctuation

Both line comments and doc comments must be capitalized. Each sentence must end with a period.

```
// This is a line comment.
```

### Avoid overly long comment lines

We recommend a soft comment line length limit of **100 characters**. Authors should aim to wrap lines before hitting this limit, but it is not a hard limit. Comments are allowed to exceed this limit.

### Verbs in function description

Comments describing a function usually start with a verb. That verb must use the third-person present tense, e.g. "Creates", "Sets", "Computes".

### Function arguments

Comments for function arguments must adhere to this pattern:

```
/// Performs a certain computation. Any other description of the function.
///
/// # Arguments
/// * `arg1` - The first argument.
/// * `arg2` - The second argument.
pub fn compute(...
```

0 comments on commit 24cc9b4

Please sign in to comment.