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

Ouverte
  • Quelque chose ne va pas ?
#66 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
markdown
Domaine
documentation

Piste de recherche

Commencez par comparer les fichiers de premier niveau listés dans dejacode, purldb, scancode.io, scancode-toolkit et vulnerablecode. L’issue désigne des objectifs immédiats : convertir RELEASE.md dans dejacode et scancode.io en rST, renommer les fichiers apache-2.0.LICENSE en LICENSE et documenter la norme pour les nouveaux dépôts AboutCode. Le travail est considéré comme terminé lorsque la convention de nommage/format des fichiers est appliquée ou clairement documentée, mais l’issue est ancienne et concerne plusieurs dépôts.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
JavaScript
Étoiles
9
Forks
17
Merge moyen
7 h 55 min
PR mergées (30 j)
2

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de aboutcode-org/www.aboutcode.org

Toutes les issues de aboutcode-org/www.aboutcode.org

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.