mirror of
https://github.com/tlsnotary/tlsn-utils.git
synced 2026-01-08 04:13:59 -05:00
Update CONTRIBUTING.md (#30)
This commit is contained in:
@@ -33,4 +33,36 @@ depending on the types of changes defined by
|
|||||||
- `Fixed` for any bug fixes.
|
- `Fixed` for any bug fixes.
|
||||||
- `Security` in case of vulnerabilities.
|
- `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(...
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user