Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.59 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.

Table of Contents

Adding to This List

Please ensure your pull request adheres to the following guidelines:

  • Search open and closed PRs to avoid duplicate suggestions.
  • Only submit design patterns that you think would be useful to others. This implies each pattern has enough succinct content to describe why it's useful.
  • Design pattern are listed alphabetically by category. Add your pattern alphabetically in the proper category of the README document.
  • Use title-case, e.g. "Factory Method", "Chain of Responsibility".
  • Code formatting should follow standard Prettier default settings, including:
    • Indent with two spaces
    • Use double quotes
    • Avoid letting your code formatter format other section of the README file.
  • Check your spelling and grammar.
  • The PR should have a useful title.

Thank you for your suggestions!

Updating Your Pull Request

Sometimes a maintainer will ask you to edit your pull request before it's included. This is normally due to spelling errors or because your PR didn't match the above guidelines guidelines. This write-up covers the different ways you can change a pull request.