contributing - Foi adicionado o arquivo de CONTRIBUTING.md #13
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,62 @@ | ||||||
| <p align="center"> | ||||||
| <br /> | ||||||
| <img src="./public/logo.svg" width="400" /> | ||||||
| </p> | ||||||
| <p align="center"> | ||||||
| <a target="_blank" href="https://hacktoberfest.lukin.co">Site</a> • | ||||||
| <a href="#setup">Setup</a> • | ||||||
| <a href="#license">License</a> • | ||||||
| <a target="_blank" href="https://lukin.co">Lukin Co.</a> | ||||||
| </p> | ||||||
| <br/> | ||||||
| <br/> | ||||||
|
|
||||||
| > ## Para contribuir com o projeto você deverar seguir algumas etapas para que seu PR seja aceito. | ||||||
| - Fazer um fork do repositório. | ||||||
| - Abrir uma issue. | ||||||
| - Criar uma branch. | ||||||
| - Commitar suas modificações. | ||||||
| - Criar uma PR. | ||||||
|
|
||||||
| <br> | ||||||
|
|
||||||
| ### Como abrir um issue? | ||||||
|
|
||||||
| Na aba de criar um issue, ao clicar em **`New issue`** você deve descrever o mais claro possivél: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - **Title**: com um título que representa o seu issue. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - **Leave a comment**: com uma descrição detalhada do que deve ser feito no | ||||||
| issue. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Se quiser poderá colar codigos para uma descrição mais clara. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| Feito isso, clique em **`Submit new issue`**. | ||||||
|
|
||||||
| ### Como criar um branch? | ||||||
| ```javascript | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| git checkout -b my-new-feature | ||||||
| ``` | ||||||
| Faça suas alterações e depois um commit. | ||||||
|
|
||||||
| ### Como fazer mensagens de commit? | ||||||
| ```javascript | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| git commit -m '[nome da branch] - Add some feature' | ||||||
| ``` | ||||||
|
|
||||||
| - Um bom padrão para fazer seus commits comece com o nome da suas branch e depois uma breve descrição dela. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Exemplo:<br><br> | ||||||
| **"animated-scroll - foi criado uma animação ao fazer um scroll na tela"** | ||||||
|
|
||||||
| ### Como criar um pull requests? | ||||||
| Após fazer o push de sua branch: | ||||||
|
|
||||||
| ```javascript | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| git push -u origin my-new-feature | ||||||
| ``` | ||||||
|
|
||||||
| - Ir na aba **`Pull requests`** e clicar no botão **`New pull requests`** | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - Descreva ao maximo de todas as suas alterações na **`PR`** | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| <br> | ||||||
|
|
||||||
| **Depois de mergearmos seu `PR` você pode excluir sua branch.** | ||||||
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.