Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

44 lines (25 loc) · 2.6 KB

How to contribute

First, thank you for considering contributing! It's people like you that make the open source community such a great community! 😊

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Check if the feature was not already reported by searching on GitHub under Issues.

  • If you're unable to find an issue addressing the feature, open a new one. Be sure to include a title and clear description, as much relevant information as possible, along with the current and expected behavior.

  • If the suggestion received a positive feedback, you can start writing code.

Will you submit new code?

  • Don't forget to run yarn build:ci. Commits that doesn't pass the ci build won't be accepted.

Commit message guidelines

This project follows the Conventional Commits as a way to simplify the publishing process and the changelog generation. As such, to make things easier to commit, make sure to use the commitizen tool to commit, running yarn commit instead of git commit.

Do you have questions about the source code?

Feel free to ask, opening a new Github issue.

Thanks! ❤️ ❤️ ❤️