Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.58 KB
Raw

Contributing

We ❤️ pull requests and we're always working to make it as easy as possible for people to contribute.

If you want to contribute but don't know on where you can help, check the issues and look for ones with the PR-welcome label.

We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A team member will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.

Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context or information regarding the roadmap that the core team members have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it. 😄

All PRs should be accompanied with tests and pass the linting rules when applicable.

Code of Conduct

By participating in this project you agree to abide the terms of our Code of Conduct.

Reporting Bugs or asking for new features

Please use the issue tracker to report any bugs or suggest any enhancements. Be sure to search through the existing issues before creating a new one, and add as much detail as possible to your issue.

Pull request (PR) process

  1. Fork the repository
  2. Create a new branch (git checkout -b new-branch)
  3. Make your changes
  4. Commit your changes (git commit -m 'feat(<scope>): Add some feature'). Make sure to follow the Conventional Commits format for your commit message.
  5. Push to the branch (git push origin new-branch)
  6. Create a new Pull Request

Tips to ensure a successful PR

  • Make sure to update the documentation if necessary, and update the README.md if needed.
  • If you made code changes, make sure to add tests for those changes.
  • If your PR is linked to an issue, make sure to add the issue number in the PR description.
  • Detail the changes you made in the PR description, and explain why you made those changes.

Thank you for your contribution!