Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SUGESTÃO] Sugestão de melhorias no arquivo CONTRIBUTING.md para novos colaboradores #52788

Open
Marcelo-Augusto-Silva opened this issue Dec 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Marcelo-Augusto-Silva
Copy link

Primeiramente, gostaria de parabenizar pelo excelente trabalho no arquivo CONTRIBUTING.md, que já fornece orientações muito úteis para quem deseja contribuir com o projeto. Tenho uma sugestão que pode ajudar a tornar o guia ainda mais amigável para novos colaboradores:

Adicionar explicações breves sobre os comandos:

Um pequeno resumo do propósito de cada comando listado pode ajudar quem está começando a entender melhor o processo.
Inserir exemplos práticos:

Um exemplo simples de fluxo de contribuição (como corrigir um erro ou adicionar uma funcionalidade fictícia), mostrando os passos de fork, branch, commit, push e PR, seria um complemento valioso.
Incluir uma seção de boas práticas:

Talvez uma seção com dicas sobre formatação de código, ferramentas de linting ou testes que possam ser utilizados antes de enviar um PR.
Fornecer links para materiais adicionais:

Links para tutoriais ou documentação relacionados ao projeto poderiam enriquecer ainda mais a experiência dos colaboradores.
Espero que essas ideias sejam úteis! Estou à disposição para ajudar a implementar essas sugestões, caso sejam aprovadas.

@Marcelo-Augusto-Silva Marcelo-Augusto-Silva added the enhancement New feature or request label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant