search

aztecweb / lista-de-compras

Aplicação construída pela Comunidade da Formação Aztec.
GNU General Public License v3.0
15 stars 8 forks source link

Definição do README do projeto #1

Closed mateusrovedaa closed 2 years ago

mateusrovedaa commented 2 years ago

Descrição

O arquivo README de um projeto é o cartão de visitas do projeto para a comunidade ou até mesmo serve como um guia interno de como utilizar determinada ferramenta ou o que precisa para o projeto funcionar. Basicamente, o README é composto por todas informações úteis de um projeto desde:

A Rocketseat fez um excelente post contando um pouco mais desse arquivo, então recomendo a leitura para entender ainda um pouco mais sobre o que é e qual a finalidade desse importante arquivo para o projeto.

O que é README e por que ele é tão importante?

Objetivo

Definir e discutir quais informações farão parte do README deste projeto. Além disso, precisamos também debater sobre como deixar este arquivo tão importante bem organizado, facilitando o entendimento de pessoas que não conhecem sobre o projeto, auxiliando quem quer contribuir e mantendo informações importantes para a execução e utilização.

Anexado a essa issue se encontram os arquivos que foram disponibilizados pelo site devChallenges como artefatos iniciais.

Artefatos

marcosvile commented 2 years ago

vamos começar com a criação dos tópicos no readme:

podemos distribuir cada tópico em uma issue, atribuir um responsável para criar um esboço e gerenciar a issue, e todos em comum discutirem na issue as contribuições e sugestões da descrição de cada tópico.

marcosvile commented 2 years ago

vale também, iniciar um quadro kanban na aba projetos, para gerenciar a conclusão de cada tarefa/issue nos cards.

aldair-meneses commented 2 years ago

Alguns tópicos que são interessantes estar no README:

mateusrovedaa commented 2 years ago

Tópicos que acho interessante termos no README:

O que acho que pode ser um bônus mas que não precisam ser feito agora:

RaisaSampaio commented 2 years ago

Cheguei por aqui agora! Gostei da ideia de separar um responsável pra cada tópico e acredito que podemos discutir o que cada um sentiu dificuldade na construção de cada tópico. Acredito que o quadro Kanban vai ser crucial para o andamento do projeto. Confesso que é tudo muito novo pra mim mas sei que com cada um ajudando um pouquinho vou conseguir me situar melhor.

mateusrovedaa commented 2 years ago

Definições sobre a criação do README:

Tópicos que precisam estar no README

marcosvile commented 2 years ago

Para a criação do readme, estou me guiando sobre as marcações Markdown pelo conteúdo do link:

https://docs.pipz.com/central-de-ajuda/learning-center/guia-basico-de-markdown#open

marcosvile commented 2 years ago

Pensando no desenvolvimento do projeto e completar as informações no readme, estou lendo sobre o licenciamento do projeto na documentação do github:

https://docs.github.com/pt/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository

e pelo conteúdo:

http://www.gnu.org/licenses/quick-guide-gplv3.html

o que acham?