This repository was archived by the owner on Apr 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathCONTRIBUTING.md
34 lines (29 loc) · 2.96 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Bem-vindo(a) à documentação de contribuição do Dev-Help!
Desde já, queríamos agradecê-lo(a) por dedicar seu tempo à leitura deste documento. Qualquer contribuição será extremamente bem-vinda.
## Como começar?
### Issues
Na aba de [Issues](https://github.com/Dev-Help-Oficial/Blog/issues) você pode reportar problemas no site e também pode dar sugestões de melhorias.
Observação: Escreva em Português legível e também coloque Labels(Etiqueta) no Issue, caso for uma sugestão de melhoria, marque o Issue com a Label(Etiqueta) "Enhancement" e caso for um bug marque com a Label(Etiqueta) "Bug".
### Artigos
Contribuições com melhorias em artigos já existentes e contribuições com novos artigos são de extrema importância para nós.
Para contribuir com um novo artigo, siga os passos abaixo:
1. Crie um fork [deste repositório](https://github.com/Dev-Help-Oficial/Blog)
Para criar um fork, é extremamente simples, na aba "Code"(Código) do repositório existe o botão "Fork" basta clicar neste botão.
2. No repositório de seu fork, entre na página posts e selecione a opção "Add file"(Adicionar arquivo) e após isso clique na opção "Create new file"(Criar novo arquivo).
3. Na caixa de texto com o título de "Name your file"(Nomeie seu arquivo) escreva o nome de seu artigo com a extensão .md(markdown). Por exemplo: "comecando-com-nextjs.md"(O nome do arquivo não pode conter letras maiúsculas, nem caracteres especiais como acentos, apenas letras e traços).
4. No começo do artigo, você deve colocar os metadados do artigo no formato abaixo:
5. Escreva o conteúdo do artigo usando o formato [Markdown do Github](https://docs.github.com/pt/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) para formatação, você também pode usar tags HTML(Hypertext Markup Language) para formatação mas não pode usar CSS(Cascading Style Sheets) nem Javascript.
6. Após terminar de escrever o artigo seguindo os passos acima, você deve fazer um commit do seu artigo clicando no botão "Commit changes"(Salvar mudanças).
7. Após salvar as mudanças, finalmente você deve criar uma nova Pull request para finalizar sua contribuição, na aba "Pull requests" de seu fork clique no botão "Create new pull request"(Criar nova pull request) após isso confirme o Pull request clicando no botão "Create new pull request" na página que acabou de se abrir.
8. Na página que abriu, dê um título personalizado e adicione uma descrição(Opcional) e clique no botão "Create pull request" no final da página.
