-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Contributions | ||
|
||
## Pull requests | ||
The steps to contribute to the evolution of the code, whether to solve bugs or create features are as follows: | ||
|
||
- Create a project fork | ||
- Create a new branch | ||
- Make changes or add features | ||
- Commit changes and send them to the remote | ||
- Make pull request and assign to a reviewer | ||
- In case of revisions: make new commits in the same branch created and send to the remote | ||
|
||
An example of a bug resolution would follow the following flow: | ||
|
||
```shell | ||
$ readme-template (master)> git pull origin master | ||
$ readme-template (master)> git checkout -b bug/bug-xpto | ||
$ readme-template (bug/bug-xpto)> git commit -a -m "Fix bug" | ||
$ readme-template (bug/bug-xpto)> git push origin bug/bug-xpto | ||
``` | ||
|
||
Then open a Pull Request for your modification. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Contribuições | ||
|
||
## Pull requests | ||
Os passos para contribuir com a evolução do código, seja para resolução de bugs ou criação de features são os seguintes: | ||
|
||
- Criar um fork do projeto | ||
- Criar um branch novo | ||
- Realizar mudanças ou adicionar features | ||
- Commitar mudanças e enviá-las para o remoto | ||
- Realizar pull request e atribuir a um revisor | ||
- Caso existam revisões: realizar novos commits no mesmo branch criado e enviar para o remoto | ||
|
||
Um exemplo de resolução de bug seguiria o seguinte fluxo: | ||
|
||
``` shell | ||
$ readme-template (master) > git pull origin master | ||
$ readme-template (master) > git checkout -b bug/bug-xpto | ||
$ readme-template (bug/bug-xpto) > git commit -a -m "Corrigi bug" | ||
$ readme-template (bug/bug-xpto) > git push origin bug/bug-xpto | ||
``` | ||
|
||
Depois abra um Pull Request para sua modificação. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 Jamessom Queiroz | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |