tlsnotary/tlsn
1
0
Fork 0
mirror of https://github.com/tlsnotary/tlsn.git synced 2026-01-08 21:08:04 -05:00
Code Issues Packages Projects Releases 12 Wiki Activity

doc: added note about "format on save" to the contribution guide

Browse Source
This commit is contained in:
Hendrik Eeckhaut
2024-08-19 14:43:43 +02:00
parent 0b1eef12f3
commit 8fa593c111
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -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.