mirror of
https://github.com/moul/awesome-ssh
synced 2024-11-24 21:33:05 +00:00
24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
# Contribution Guidelines
|
|
|
|
Please ensure your pull request adheres to the following guidelines:
|
|
|
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
|
- Suggested packages should be tested and documented.
|
|
- Make an individual pull request for each suggestion.
|
|
- Use the following format: `[package](link) - Description.`
|
|
- Additions should be added to the bottom of the relevant category.
|
|
- New categories, or improvements to the existing categorization are welcome.
|
|
- Link to the GitHub repo, not official website, npm, pypi.
|
|
- Keep descriptions short and simple, but descriptive.
|
|
- Start the description with a capital and end with a full stop/period.
|
|
- Check your spelling and grammar.
|
|
- Make sure your text editor is set to remove trailing whitespace.
|
|
- The pull request should have a useful title and include a link to the package and why it should be included.
|
|
|
|
Thank you for your suggestions!
|
|
|
|
### Updating your PR
|
|
|
|
A lot of times, making a PR adhere to the standards above can be difficult.
|
|
If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it.
|
|
If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it.
|