awesome-rust/CONTRIBUTING.md

25 lines
1.4 KiB
Markdown
Raw Normal View History

2016-01-05 07:08:12 +00:00
# Contributing
2017-06-20 06:58:27 +00:00
Do you want to contribute? We'd love that.
2016-01-06 07:20:48 +00:00
2017-08-08 06:34:27 +00:00
Our goal is to have mostly projects that are stable and useful to many users.
2016-05-18 07:10:10 +00:00
2016-01-22 07:19:26 +00:00
## How?
2016-01-05 07:09:35 +00:00
2017-09-11 06:43:28 +00:00
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.
2017-09-11 06:41:36 +00:00
2016-02-15 08:03:01 +00:00
If you want to add an entry to the `README.md` please consider this:
2016-01-05 07:09:35 +00:00
2016-01-22 07:24:11 +00:00
- 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:
* example for Travis: ` [<img src="https://api.travis-ci.org/XXX/CRATE.svg?branch=master">](https://travis-ci.org/XXX/CRATE)`
* for Github actions please see https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/adding-a-workflow-status-badge#using-the-branch-parameter
2017-09-11 06:43:28 +00:00
- 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.