diff options
| author | Christian Duerr <contact@christianduerr.com> | 2020-05-05 22:50:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-05 22:50:23 +0000 |
| commit | 81ce93574f62d4b117fdd79af65391f30316a457 (patch) | |
| tree | 951a0578860c6028e2dfff0ca83879001c6b2385 /CONTRIBUTING.md | |
| parent | 04f0bcaf54ed373128ca0f84ee8fcdd8e52bce23 (diff) | |
Extend style guideline documentation
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ab17fcc..82fba0f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,6 +99,13 @@ All Alacritty changes are automatically verified by CI to conform to its rustfmt build is failing because of formatting issues, you can install rustfmt using `rustup component add rustfmt` and then format all code using `cargo fmt`. +Unless otherwise specified, Alacritty follows the Rust compiler's style guidelines: + +https://rust-lang.github.io/api-guidelines + +All comments should be fully punctuated with a trailing period. This applies both to regular and +documentation comments. + # Release Process Alacritty's release process aims to provide stable and well tested releases without having to hold |