Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 1.71 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email or any other method with the owners of this repository before working on a change.

Note we have a code of conduct and use the all-contributors specification, please follow it in all your interactions with the project.

Pull Request Guidelines

  1. In order to create a pull request, use our Pull Request Template.
  2. Please ensure your proposal will not radically change current functionality or bring along breaking changes.
  3. Document your changes thoroughly, either on README.md or a new markdown file on docs folder.
  4. Certify that your commit messages follow the Conventional Commits specification.
  5. Ensure coverage for your bug fixes or features is complete and that none of the tests fail.
  6. Be reactive to any comments, reviews or change requests entered in your pull request.
  7. Only hotfixes will be accepted for the main branch. All other cases should be directed to the dev branch.

Adding a New Contributor

Anyone who has contributed a pull request to this project is welcome to add themselves as a contributor to the README.md file. In order to do that, you can either run the command yarn add:contrib <username> <contributions> or comment on a issue or pull request a message like "@all-contributors please add @{username} for {contributions}", as explained on All Contributors Usage Guide.