Unifier l'extension les fichiers de documentation INSTALL, CHANGELOG, COPYING, SECURITY #5042

Open
opened 5 months ago by erational · 7 comments
Owner

Pour éviter de multiplier les extensions et standardiser la distribution peut-on avoir une extension commune pour les fichiers de documentation ?

  • INSTALL, CHANGELOG, COPYING (actuellement .txt)
  • SECURITY (actuellement .md)
Pour éviter de multiplier les extensions et standardiser la distribution peut-on avoir une extension commune pour les fichiers de documentation ? - INSTALL, CHANGELOG, COPYING (actuellement .txt) - SECURITY (actuellement .md)
erational added this to the 4.2 milestone 5 months ago
erational added the
divers
label 5 months ago
Owner

Disons que (et aussi en discussion avec James)

  • ça devrait être du Markdown
  • il faudrait un fichier README.md (qui pourrait regrouper l’installation)
  • COPYING devrait s’appeler LICENSE (sans extension il semblerait ?).

Par ailleurs, il pourrait y avoir:

  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
Disons que (et aussi en discussion avec James) - ça devrait être du Markdown - il faudrait un fichier README.md (qui pourrait regrouper l’installation) - COPYING devrait s’appeler LICENSE (sans extension il semblerait ?). Par ailleurs, il pourrait y avoir: - CODE_OF_CONDUCT.md - CONTRIBUTING.md

POURQUOI VOUS CRIEZ COMME ÇA

POURQUOI VOUS CRIEZ COMME ÇA

Pourquoi pas d'extension sur licence?

Par ailleurs une fois la décision prise il faudra ajuster les modeles de dépôt gitea

Pourquoi pas d'extension sur licence? Par ailleurs une fois la décision prise il faudra ajuster les modeles de dépôt gitea
Owner

Bon j’ai aussi regardé autour pour Licence, et il semble que c’est indifférent aussi.
https://opensource.stackexchange.com/questions/10239/should-i-call-my-license-file-license-license-md-or-license-txt

Bien que «par défaut» github ou gitlab créent un nom LICENSE sans extension…

Par défaut dans github c’est :

  • LICENSE
  • README.md

Par défaut, dans gitlab c’est : 

  • LICENSE, CHANGELOG
  • README.md, CONTRIBUTING.md

et aussi, pour la liste de tous les fichiers généralement utililisés

Mais bon, il semble que toutes les forges comprennent si c’est sans extension, avec .md ou avec .txt …

Il y a un renvoi sur https://opensource.guide/fr/ qui semble une ressource intéressante par ailleurs.

Bon j’ai aussi regardé autour pour Licence, et il semble que c’est indifférent aussi. https://opensource.stackexchange.com/questions/10239/should-i-call-my-license-file-license-license-md-or-license-txt Bien que «par défaut» github ou gitlab créent un nom LICENSE sans extension… Par défaut dans github c’est : - LICENSE - README.md Par défaut, dans gitlab c’est :  - LICENSE, CHANGELOG - README.md, CONTRIBUTING.md et aussi, pour la liste de tous les fichiers généralement utililisés - https://github.com/joelparkerhenderson/github-special-files-and-paths - ou encore https://github.com/kmindi/special-files-in-repository-root/blob/master/README.md Mais bon, il semble que toutes les forges comprennent si c’est sans extension, avec .md ou avec .txt … Il y a un renvoi sur https://opensource.guide/fr/ qui semble une ressource intéressante par ailleurs.
b_b added the
amélioration
label 5 months ago
Owner
https://git.spip.net/spip/spip/src/branch/issue_5042_readme/README.md en base de travail.
JamesRezo added
documentation
and removed
divers
labels 5 months ago
Owner
Pour info, un nouveau fichier dans la série https://gdpr-txt.org/ cité ici https://framablog.org/2022/03/08/faciliter-la-conformite-rgpd-le-fichier-gdpr-txt/
Owner

Est-ce qu’on clôt ce ticket ?
Quitte à en ouvrir un autre pour les fichiers suivants ?

  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
Est-ce qu’on clôt ce ticket ? Quitte à en ouvrir un autre pour les fichiers suivants ? - CODE_OF_CONDUCT.md - CONTRIBUTING.md
Sign in to join this conversation.
No Milestone
No project
No Assignees
5 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.