diff options
| author | Christian Duerr <contact@christianduerr.com> | 2020-05-03 01:25:56 +0200 |
|---|---|---|
| committer | Kirill Chibisov <contact@kchibisov.com> | 2020-05-04 03:04:16 +0300 |
| commit | fa94fc3388829cd919d2b4c14d8f0ef842a7bcc2 (patch) | |
| tree | 8497a9be240d13fb0a3292ebbaf45931de2ce4c1 | |
| parent | 04f0bcaf54ed373128ca0f84ee8fcdd8e52bce23 (diff) | |
| download | alacritty-fa94fc3388829cd919d2b4c14d8f0ef842a7bcc2.tar.gz alacritty-fa94fc3388829cd919d2b4c14d8f0ef842a7bcc2.zip | |
Extend style guideline documentation
| -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 |