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

Criar um README para o projeto #80

Open
danielg-favero opened this issue Jul 23, 2022 · 0 comments
Open

Criar um README para o projeto #80

danielg-favero opened this issue Jul 23, 2022 · 0 comments

Comments

@danielg-favero
Copy link
Member

danielg-favero commented Jul 23, 2022

Desde o início do projeto ele não possui um README para ensinar novos membros como começar a programar no projeto, instalar as dependências, como é o gitflow do repo e como realilzar os PRs para o github

Campos interessantes de se estar no README:

  • Introdução
  • Quem desenvolveu esse projeto
  • Como começar no projeto
    - Clonar repositório
    - Baixar dependências
  • Estrutura das pastas
  • Como começar a desenvolver
    - Como criar páginas
    - Como criar componentes
  • Gitflow da aplicação

Exemplo de repositório com README: https://github.com/danielg-favero/triggers-postgres
Documentação de como escrever um bom README: https://www.makeareadme.com/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant