spip
/
spip
32
14
Fork 15
Code Issues 434 Pull Requests 13 Projects Releases Wiki Activity
Labels Milestones
New Issue

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

Closed
opened 1 year ago by erational · 8 comments
erational commented 1 year ago
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 1 year ago
erational added the
divers
 label 1 year ago
marcimat commented 1 year 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
👍 1
rastapopoulos commented 1 year ago
Owner

POURQUOI VOUS CRIEZ COMME ÇA

POURQUOI VOUS CRIEZ COMME ÇA
maieul commented 1 year ago
Collaborator

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
marcimat commented 1 year ago
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 1 year ago
marcimat commented 1 year ago
Owner

https://git.spip.net/spip/spip/src/branch/issue_5042_readme/README.md en base de travail.

https://git.spip.net/spip/spip/src/branch/issue_5042_readme/README.md en base de travail.
JamesRezo added
documentation
 and removed
divers
 labels 1 year ago
b_b commented 1 year 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/

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/
marcimat commented 10 months ago
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
👍 2
erational commented 6 months ago
Poster
Owner

Je ferme donc le ticket.

Merci @marcimat pour ce grand bond en avant.

Je ferme donc le ticket. Merci @marcimat pour ce grand bond en avant.
erational closed this issue 6 months ago
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
1.8
1.9.1
1.9.2
2.0
2.1
3.0
3.1
3.2
4.0
4.1
4.2
boutons-danger
coquille_doc
debug_ecrire_fichier
dev-sortable
dev/autoloader
dev/hasard_fixe
dev/instituer_ergo
dev/issue_4626_menu_squelettes
dev/issue_5496_intro_ligne_null
dev_infos_image
fix/valider_url_distante
fix_issue_5454
fix_modifier_login
issue_4101
issue_4678
issue_4705
issue_4717
issue_4836
issue_4946
issue_5095
issue_5344
issue_5427_bis
master
refactor_extraire_balises
remove_no_image_filtrer
trigger_deprecated_42
Labels
Apply labels
Clear labels
accessibilité amélioration
Amélioration, nouvelle fonctionnalité APIs authentification base de données bug
Ca ne fonctionne pas code généré compilo css divers documentation doublon
Ce ticket est un doublon ergonomie espace privé filtres et balises formulaires Inscription installation invalide
Ticket invalide javascript langues LDAP plugin PostgreSQL refusé
Ignoré, c'est comme Ca... sécurité traduction
No Label accessibilité amélioration APIs authentification base de données bug code généré compilo css divers documentation doublon ergonomie espace privé filtres et balises formulaires Inscription installation invalide javascript langues LDAP plugin PostgreSQL refusé sécurité traduction
Milestone
Set milestone
Clear milestone
No items
No Milestone
4.2
Projects
Clear projects
No project
Assignees
Assign users
Clear assignees
No Assignees
5 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Write Preview
Loading…
Cancel
Save
There is no content yet.
Delete Branch '%!s(MISSING)'

Deleting a branch is permanent. It CANNOT be undone. Continue?

No
Yes