diff options
| author | Fuwn <[email protected]> | 2021-06-05 21:54:35 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-06-05 21:54:35 -0700 |
| commit | 8ffc66459323335b6c162d2230d9a05e5b07d037 (patch) | |
| tree | 6293996591059a9528f09de74590397af6bd1183 /CONTRIBUTING.rst | |
| parent | chore(build): delete backup file (diff) | |
| download | whirl-8ffc66459323335b6c162d2230d9a05e5b07d037.tar.xz whirl-8ffc66459323335b6c162d2230d9a05e5b07d037.zip | |
docs(contributing): md -> rst
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..225997f --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,14 @@ +Contribution Guidelines +======================= + +This document isn't very well detailed at the moment... + +Guidelines +---------- + +1. Make sure your PR compiles. If the GitHub action "Rust ✅/ 🚫" fails, your PR + will be declined. +2. Make sure your commit changes something other than just formatting. +3. If you change updates any of the :code:`Cargo.toml` files, make sure to + `install <https://github.com/est31/cargo-udeps#installation>`_ and run + :code:`cargo +nightly udeps` to ensure there aren't any unused dependencies. |