Create guidelines for README Files
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- markdown
- Domínio
- documentation
Direção de pesquisa
Revise primeiro os arquivos README do repositório e sua estrutura Docusaurus/Markdown e, em seguida, compare-os com as boas práticas relevantes da comunidade. Defina a estrutura padronizada do README e documente as diretrizes para que as informações essenciais sejam consistentes em todos os projetos AboutCode.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Create a standardized structure for README files across AboutCode projects, aligning with community best practices. By developing a consistent format, we can enhance clarity, improve user onboarding, and ensure that essential information is easily accessible.
- Linguagem predominante
- JavaScript
- Estrelas
- 9
- Forks
- 17
- Merge médio
- 7h 55min
- PRs com merge (30d)
- 2
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de aboutcode-org/www.aboutcode.org
-
Making all post button.Talvez já em andamento @sarthaklole assumiu há 70 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
aboutcode-org/www.aboutcode.org#117 · 3 comentários ·
-
WWW: Reduce frequency of update-releasesTalvez livre de novo @johnmhoran assumiu há 51 dias e não há nenhum pull request aberto. Abertaci-workflow
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 45/100
aboutcode-org/www.aboutcode.org#180 · 1 responsável ·
-
DOCS: Create new AboutCode stack diagram(s)Talvez livre de novo @hixvikas assumiu há 53 dias e não há nenhum pull request aberto. Abertadocumentation
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
aboutcode-org/www.aboutcode.org#166 · 1 comentário ·
-
WWW: Create About top level page?Talvez já em andamento @pombredanne assumiu há 154 dias. Abertawebsite
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 35/100
aboutcode-org/www.aboutcode.org#164 · 1 reação · 1 responsável ·
-
WWW: Add Initiatives and grant ProjectsTalvez livre de novo @mjherzog assumiu há 241 dias e não há nenhum pull request aberto. Abertaenhancement needs design website
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
aboutcode-org/www.aboutcode.org#141 · 1 responsável ·
Todas as issues de aboutcode-org/www.aboutcode.org
Issues semelhantes
-
Package downloads never retry: getUrlWithResuming's retry catch cannot see a rejected requestAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
Mantenedores costumam responder em até 1 dia
-
account: profile bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 5 dias
-
ai-driven-fuzzing bug claude Minor
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
linagora/cozy-client#1777 · 1 comentário · 1 reação ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
NanmiCoder/dsh-agent-teams#326 ·
Mantenedores costumam responder em até 1 dia
-
[guide] AGENTS.md claims the coverage gate, e2e and full lint run on every PR after ADR 0011 focused validationTalvez já em andamento @hivecommons-hive assumiu hoje. Abertaagent/guide documentation hive/claimed-by-guide stage/040-covered-by-pr
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 81/100
cncf/endusers#2006 · 1 comentário ·
Mantenedores costumam responder em até 1 dia