rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-05-13 22:26:34 +02:00
Code Issues Releases Activity

Add dprint instructions to CONTRIBUTING.md (#1389)

Browse Source
This commit is contained in:
Martin Geisler 2023-10-20 13:52:36 +02:00 committed by GitHub
parent 9637e3c607
commit 0f0d46bb93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
CONTRIBUTING.md
View File

@ -3,6 +3,41 @@
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.
## Formatting
Please ensure that your files are formatted consistently. We use [`dprint`] for
this and you should follow their installation instructions for your platform. We
rely on a few tools in addition to `dprint`:
- [`rustfmt`] for formatting Rust code.
- [`yapf`] for formatting Python code.
- [`msgcat`] for formatting PO files.
### Linux
On Debian, you install `rustfmt` via `rustup` and you can install the other
tools using
```sh
sudo apt install yapf3 gettext
```
### MacOS
> _TODO: to be filled in by someone using a Mac._
### Windows
On Windows, you can should use [Gettext binaries for Windows].
> _TODO: fill in how to install `yapf` on Windows._
[`dprint`]: https://dprint.dev/
[`rustfmt`]: https://github.com/rust-lang/rustfmt
[`yapf`]: https://github.com/google/yapf
[`msgcat`]: https://www.gnu.org/software/gettext/manual/html_node/msgcat-Invocation.html
[Gettext binaries for Windows]: https://mlocati.github.io/articles/gettext-iconv-windows.html
## Contributor License Agreement
Contributions to this project must be accompanied by a Contributor License