1
0
mirror of https://github.com/rust-unofficial/awesome-rust.git synced 2024-12-02 02:56:33 +02:00
awesome-rust/CONTRIBUTING.md
Tom Parker-Shemilt 0513259ff9 Realised that the Github actions default to the default branch for a repo
(unlike Travis) and so the branch error isn't needed any more
2021-07-30 18:37:30 +01:00

1.4 KiB

Contributing

Do you want to contribute? We'd love that.

Our goal is to have mostly projects that are stable and useful to many users.

How?

The easiest way is to go to https://github.com/rust-unofficial/awesome-rust/blob/master/README.md and click on the "pen" icon in the upper right corner. Make the changes to the file and follow the instructions to create a pull request.

If you want to add an entry to the README.md please consider this:

  • is the entry valuable to people trying to get things done in Rust?
  • if you want to add something, please use the template [ACCOUNT/REPO](https://github.com/ACCOUNT/REPO) [[CRATE](https://crates.io/crates/CRATE)] — DESCRIPTION
    • if you've not published your crate to crates.io remove the [[CRATE](...)] part.
    • if you have a CI build, please add the build badge. Put the image after the description, separated by a space. Please make sure to add the branch information to the image:
  • please pay attention to the alphabetical ordering.

Removing projects

We don't remove projects unless they are outright broken or pronounced deprecated by another project or by its author.