Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.08 KB

contributing.md

File metadata and controls

37 lines (28 loc) · 2.08 KB

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.

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: awesome-automotive
  2. Click on the readme.md file:

3. Now click on the edit icon.

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](https://help.github.com/articles/github-flavored-markdown/).

5. Say why you're proposing the changes, and then click on "Propose file change".

6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!

7. Time to wait for [pull request](https://help.github.com/articles/using-pull-requests/) review and merge.

8. Be proud that your changes are part of [awesome-automotive](https://github.com/Marcin214/awesome-automotive)

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.

Here is great introduction to Git and Github ❗