Mirrors/awesome-rust
2
0
Fork 0
mirror of https://github.com/rust-unofficial/awesome-rust synced 2024-11-26 22:00:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #949 from FlashSystems/update_contributing

Browse source 
Updated the contribution guide with a new template
This commit is contained in:
Tom Parker-Shemilt 2020-09-01 22:36:08 +01:00 committed by GitHub
commit b1bb159f30
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -11,8 +11,11 @@ The easiest way is to go to https://github.com/rust-unofficial/awesome-rust/blob
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 `[YYY](https://crates.io/crates/YYY) — DESCRIPTION [<img src="https://api.travis-ci.org/XXX/YYY.svg?branch=master">](https://travis-ci.org/XXX/YYY)`
* If you're adding a build badge please make sure to add the branch information to the image (as per the example above for Travis). For Github actions please see https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#example-using-the-branch-parameter
- 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 want to add a 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/actions/configuring-and-managing-workflows/configuring-a-workflow#example-using-the-branch-parameter
- please pay attention to the alphabetical ordering.