Do you want to contribute to the project and don't know how to do it? 😕❓
Follow the steps below and get to work! 😆
The branch needs to be off of master. Follow the steps to create your branch name:
-
First open the issue on GitHub and click "Open in new tab".
-
Then click "Create a branch" to create a new branch already linked to your issue.
-
In the new window, the branch name suggestion will appear according to the issue.
-
Now add your GitHub username at the beginning of the branch name, separating them with a bar
/.
In your terminal, access your branch using the command:
git checkout your-branch-name.
Always do semantics commits. Use the following commit pattern to keep an organized history and use only the first 3 letters of each type:
| types | when to use | how to use |
|---|---|---|
| chore | Maintenance tasks such as updating dependencies. | cho |
| docs | Documentation update. | doc |
| feat | Addition of a new functionality or feature. | fea |
| fix | Correção de um bug. | fix |
| refactor | Refactoring existing code. | ref |
| style | Style changes that do not affect the meaning of the code | sty |
| test | Addition or modification of tests. | tes |
Example:
git commit -m fea: my new feature.
git push origin your-branch-name.
Describe what changes were made and how they affect the project. Provide detailed information about your changes. Piece of cake 🍰⭐