Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

DOCS: Create standard for format and structure of top-level project files across AboutCode repos

Aberta
  • Algo errado?
#66 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
markdown
Domínio
documentation

Direção de pesquisa

Comece comparando os arquivos de nível superior listados em dejacode, purldb, scancode.io, scancode-toolkit e vulnerablecode. A issue nomeia alvos imediatos: converter RELEASE.md em dejacode e scancode.io para rST, renomear os arquivos apache-2.0.LICENSE para LICENSE e documentar o padrão para novos repositórios AboutCode. Está concluído quando a convenção de nomenclatura/formato de arquivos for aplicada ou claramente documentada, mas a issue é antiga e abrange vários repositórios.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation

In most AboutCode repos we have a set of top-level project files including:

  • AUTHORS.rst
  • CHANGELOG.rst
  • CODE_OF_CONDUCT.rst
  • CONTRIBUTING.rst
  • LICENSE
  • NOTICE
  • README.rst
  • RELEASE.md (dejacode and scancode.io)
  • ROADMAP.rst

I looked at dejacode, purldb, scancode.io. scancode-toolkit and vulnerablecode as the primary examples

Although the GitHub norm is for the these files to be in markdown format we are using rST in most cases so the cost/effort to move to markdown does not make sense at this time.

For the LICENSE and NOTICE files we have a mixed bag:

  • dejacode: LICENSE file but no NOTICE (makes sense for AGPL-3.0 vs Apache-2.0)
  • purldb: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
  • scancode.io: LICENSE and NOTICE files - this should be the pattern for all projects licensed under Apache-2.0)
  • scancode-tookit: NOTICE file plus apache-2.0.LICENSE and cc-by-4.0.LICENSE
  • vulnerablecode: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE

If you have a top-level file named LICENSE GitHub displays the license name in a "tab" at the top of the README. Using LICENSE as the file suffix does not seem to mean anything to GitHub.

The issue here is to standardize the format and structure of these files across repos and document it for new projects/repos. Some immediate action items include:

  • Convert RELEASE.md files to rST for dejacode and scancode.io (this should be easy since these are small chunks of text)
  • Rename apache-2.0.LICENSE files to LICENSE.
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

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de aboutcode-org/www.aboutcode.org

Todas as issues de aboutcode-org/www.aboutcode.org

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.