Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.18 KB

contributing.md

File metadata and controls

43 lines (30 loc) · 2.18 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.

Guidelines

Your contributions are always welcome! Please ensure your pull request adheres to the following guidelines:

Pull Request Guidelines

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Use the following format: - [Project Name](link) - Description.
  • New categories, or improvements to the existing categorization are welcome.
  • 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 project and why it should be included.

Project Standards

  • Projects must be open source and have a public repository.
  • Projects should be actively maintained (regular commits within the last 12 months).
  • Projects should have meaningful functionality beyond basic examples.
  • Projects should have good documentation with clear installation and usage instructions.
  • Projects should demonstrate community engagement (reasonable stars/forks for their age).

Adding a New Project

When adding a new project, please ensure it:

  1. Fits into one of the existing categories or warrants a new category
  2. Includes a concise, clear description of what it does
  3. Has the format: - [Name](URL) - Description.
  4. Is added to the bottom of the relevant category
  5. Has the GitHub star count if it's significant (1k+ stars)

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 on the different ways you can update your PR so that we can merge it.

Thank you for your suggestions!