Skip to content

Commit

Permalink
doc: added note about "format on save" to the contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
heeckhau committed Aug 21, 2024
1 parent 0b1eef1 commit 8fa593c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Try to do one pull request per change.

## Style

This repository includes a `rustfmt.toml` file with custom formatting settings that are automatically validated by CI before any Pull Requests (PRs) can be merged. To ensure your code adheres to these standards, format your code using this configuration before submitting a PR. We strongly recommend enabling *auto format on save* to streamline this process. In Visual Studio Code (VSCode), you can enable this feature by turning on [`editor.formatOnSave`](https://code.visualstudio.com/docs/editor/codebasics#_formatting) in the settings.

### Capitalization and punctuation

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

0 comments on commit 8fa593c

Please sign in to comment.