Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 1.46 KB
Raw

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.

We welcome

  • Additions: restricted to addition of one new entry per pull-request.
  • Removals: restricted to removal of one obsolete entry per pull-request.
  • Edits: you may correct the descriptions if it can be improved.

Criteria for accepting a pull-request

Contributors, make sure that:

  • a short pitch is included in the pull-request description,
  • if the entry is a software:
    • the entry is open-source with appropriate license,
    • it should be maintained (at least a commit / a release in the past 3 years),
  • the table of contents has been updated (if a section is added / removed).
  • the contents are sorted alphabetically,

Thank you for your suggestions!

Maintainers, make sure that:

  • the above criteria are followed,
  • the tests pass on the CI,
  • in case of addition or removal, make an assessment of awesomeness of the entry.

Updating your PR

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.

Appendix: running lint tests

To run tests locally:

# using ruby
gem install awesome_bot
awesome_bot README.md
# using node.js
npm install -g awesome-lint
awesome-lint README.md