Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.67 KB

contributing.md

File metadata and controls

29 lines (22 loc) · 1.67 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.

Submitting a Pull Request

Ensure your pull request adheres to the following guidelines:

  • Please point all pull request to the dev branch. This is so all changes can be reviewed before merging to main for the next release.
  • In order to meet the Developer Certificate of Origin (DCO) on Pull Requests, please ensure to include Signed-off-by: Author Name authoremail@example.com in every commit message. You can also do this automatically by using the -s flag (i.e., git commit -s).
  • Additions should be added in alphabetical order in the relevant category.
  • New categories or changes to the existing categorization are welcomed.
  • Use title casing (AP Stylebook) in the following format: [List Name](link)
  • Search previous suggestions to make sure your suggestion isn't a duplicate.
  • Check your spelling and grammar.
  • Annotate your pull request to clarify what you did if the diff is unclear/confusing.

Thank you for your suggestions and/or contributions!

Updating your Pull Request

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