Skip to content

Commit

Permalink
modified contributing md
Browse files Browse the repository at this point in the history
  • Loading branch information
rootware committed May 19, 2022
1 parent 00fcf69 commit cd839ef
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contribution Guidelines

Please note that this project is released with a
[Contributor Code of Conduct](./code-of-conduct.md). By participating in this
project you agree to abide by its terms.

---

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. This can be ignored if packages share common theme or functionality, in that case can be in bulk.
* Use the following format: ```[PACKAGE](LINK) - DESCRIPTION.```
* New categories, or improvements to the existing categorization are welcome.
* Keep descriptions short and simple, but descriptive.
* End all descriptions with a full stop/period.
* Check your spelling and grammar.
* Make sure your text editor is set to remove trailing whitespace.

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. There's no need to open a new PR, just edit
the existing one. If you're not sure how to do that,
[here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
on the different ways you can update your PR so that we can merge it.

0 comments on commit cd839ef

Please sign in to comment.