CONTRIBUTING

[evandersondev]

Após eu tentar criar algumas PRs e receber feedback de como prosseguir, acho que devia ser criado um arquivo CONTRIBUTING.md para que outros ao tentar contribuir não venha passar por isso também e prosseguir da melhor forma.

Estou fazendo em uma branch mais ou menos assim, caso precise alterar algo estou disposto a alterar.

---

Site • Setup • License • Lukin Co.

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.

Como abrir um issue?

Na aba de criar um issue, ao clicar em New issue você deve descrever o mais claro possivél:

• Title: com um título que representa o seu issue.
• Leave a comment: com uma descrição detalhada do que deve ser feito no
  issue.

Se quiser poderá colar codigos para uma descrição mais clara.
Feito isso, clique em Submit new issue.

Como criar um branch?

git checkout -b my-new-feature

Faça suas alterações e depois um commit.

Como fazer mensagens de commit?

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.

Exemplo:


"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:

git push -u origin my-new-feature

• Ir na aba Pull requests e clicar no botão New pull requests
• Descreva ao maximo de todas as suas alterações na PR

Depois de mergearmos seu PR você pode excluir sua branch.

[vmarcosp]

Acho uma boa ideia @evandersondev, pode abrir um com esse arquivo de contributing e remover a seção que temos hoje no readme?

[evandersondev]

fechou vou fazer agora @vmarcosp