diff options
| -rw-r--r-- | CONTRIBUTING.md | 9 | ||||
| -rw-r--r-- | CONTRIBUTING.rst | 14 |
2 files changed, 14 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index e06a6a4..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,9 +0,0 @@ -# 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 `Cargo.toml` files, make sure to - [install](https://github.com/est31/cargo-udeps#installation) and run `cargo +nightly udeps` to - make sure there aren't any unused dependencies. 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. |