mirrors/awesome-embedded-rust
1
0
Fork 0
mirror of https://github.com/rust-embedded/awesome-embedded-rust.git synced 2024-11-18 07:29:49 +00:00
Code Issues Projects Releases Wiki Activity
awesome-embedded-rust/CONTRIBUTING.md
Berkus Decker f672db97fc Clean up contribution guidelines
2018-04-21 10:38:20 +03:00

3.1 KiB
Raw Blame History

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Table of Contents

Adding to this list

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure the item is useful before submitting. The awesome lists aim to list actually awesome projects, not collect the names of all projects in existence.
  • Make an individual pull request for each suggestion.
  • Use title-casing (AP style).
  • Use the following format: [Item Name](link) Description text
  • Link additions should be added to the bottom of the relevant alphabetical category.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request and commit should have a useful title. When you add a project - at least use Add projectX as title. See this article on guidelines to good commit messages.
  • The body of your commit message should contain a link to the repository.

Thank you for your suggestions!

Adding something to an awesome list

If you have something awesome to contribute to an awesome list, this is how you do it.

You'll need a GitHub account!

  1. Access the awesome list's GitHub page. For example: https://github.com/rust-embedded/awesome-embedded-rust
  2. Click on the readme.md file: Step 2 Click on Readme.md
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown. Step 4 - Edit the file
  5. Say why you're proposing the changes (see section Adding to this list for details), and then click on "Propose file change". Step 5 - Propose Changes
  6. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.

Here is a write up on how to change a Pull Request, and the different ways you can do that.