-
Notifications
You must be signed in to change notification settings - Fork 0
Como Contribuir Com a Wiki do ArchAppImage
Contribuir para a documentação do projeto é uma excelente maneira de ajudar o projeto, melhorar a usabilidade da ferramenta e aprender mais sobre o projeto. Muitas vezes, a documentação é negligenciada, mas desempenha um papel fundamental na adoção e manutenção do projeto. Aqui estão algumas etapas para começar a contribuir com esse projeto.
Diferente dos repositórios de código, a wiki só pode ser editada por quem é colaborador do projeto. Portanto, para contribuir você deve:
-
Entrar em contato com os mantenedores das seguintes formas: com uma issue no repositório do projeto, usando e-mail ou usando os fóruns e chats oficiais do projeto.
-
Apresente seu propósito explicando brevemente quais melhorias deseja fazer e por que deseja contribuir e aguarde a resposta e a liberação.
Opcionalmente, a wiki pode ser clonada para edição offline. Clone a wiki do projeto localmente dessa forma:
$ git clone https://github.com/LinuxDicasPro/ArchAppImage.wiki.git
Isso permite que você edite os arquivos localmente usando um editor de texto ou IDE.
Ao editar a wiki:
- Utilize a linguagem Markdown;
- Mantenha um padrão de formatação consistente;
- Se for preciso, adicione exemplos claros e precisos;
- Inclua os links para possíveis referências externas quando aplicável.
Após editar a wiki, faça um commit e envie as modificações:
$ git add .
$ git commit -m "Melhoria na documentação da wiki sobre XYZ"
$ git push origin master
Toda vez que você for editar o projeto após o commit, faça o pull para garantir que o repositório local esteja atualizado:
$ git pull origin master
Contribuir com a wiki é uma boa forma de apoiar o projeto. Pequenas melhorias podem fazer uma grande diferença para novos usuários e para a manutenção do projeto.