awesome-interview-questions/contributing.md
2021-04-19 13:44:20 +10:00

43 lines
1.9 KiB
Markdown

# Contribution Guidelines
## Table of Contents
- [Adding to this list](#adding-to-this-list)
- [Creating your own awesome list](#creating-your-own-awesome-list)
- [Adding something to an Awesome list](#adding-something-to-an-awesome-list)
- [Updating your Pull Request](#updating-your-pull-request)
## 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 list is useful before submitting. That implies it has enough content and every item has a good succinct description.
- Make an individual pull request for each suggestion.
- Use [title-casing](http://titlecapitalization.com) (AP style).
- Use the following format: `[List Name](link)`
- Link additions should be added to the bottom of the relevant category.
- New categories or improvements to the existing categorization are welcome.
- 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.
- The body of your commit message should contain a link to the repository.
Thank you for your suggestions!
## Creating your own awesome list
To create your own list, check out the [instructions](create-list.md).
## 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](https://github.com/join)!
1. Access the awesome lists GitHub page. For example: https://github.com/MaximAbramchuck/awesome-interviews
2. Click on the `README.md` file
3. Now click on the edit icon
4. Edit contents of the file using the in-browser editor to add your changes
5. Explain why you're proposing your changes, then click "Propose file change".
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)