CONTRIBUTING_EN.md

Fork the project

Fork the project to your GitHub account and clone it to your machine.

Create a branch for your contribution

Create a branch with a meaningful name for your contribution.

tips:

• say you want to add a new feature, then you can create a branch with the name feature/new-feature.

• let's say you want to fix a bug, then you can create a branch with the name bug/fix-bug.

• let's say you want to improve the documentation, then you can create a branch with the name docs/improvement-documentation.

Commits and commit messages

Commit conventions and commit messages: Conventional Commits

tips:

• Commits should be short and concise.

• Commits must be written in the imperative, that is, as if you were giving a command. Example: "Add feature" and not "Adding feature" or "Added feature".

• Commits must be written in the present tense, that is, as if it were happening now. Example: "Adds feature" and not "Added feature".

• Commits must be written in the singular, that is, as if you were talking about a single thing. Example: "Adds feature" and not "Adds features".

• Commits must be written with the first letter capitalized. Example: "Add feature" and not "add feature".

• Commits must be written with a period at the end of the message. Example: "Add feature." and not "Add feature".

• Commits must be written with a descriptive message. Example: "Add feature." and not "Add.".

Mensagens de commit exemplos

• feat: add new feature
• fix: corrects bug
• docs: update documentation
• style: formatting, semicolon missing; does not change code
• refactor: code refactoring
• perf: improves performance
• test: add or fix tests
• chore: update dependencies
• revert: undo previous commit
• build: changes that affect the build system or external dependencies (ex.: gulp, broccoli, npm)
• ci: changes to CI configuration files and scripts (ex.: Travis, Circle, BrowserStack, SauceLabs)

Opening an issue

You should normally open an issue in the following situations:

• Report a bug that.
• Discuss a high-level topic or idea (e.g. community, vision or policies)
• Propose a new role or another project idea.

If you open an issue to report a bug, please include as much detail as possible.

Sending a pull request

You should typically submit a pull request in the following situations:

• Fix a bug.
• Add a new function.
• Improve documentation.

If you submit a pull request to fix a bug, please include as much detail as possible.

License

This project is licensed under the MIT license - see the LICENSE file for details.