document Markdown pour contributions

0 views
Skip to first unread message

Thomas

unread,
Jan 13, 2022, 8:50:12 PMJan 13
to
bonjour :-)

xpost et fu2 sur fr.comp.developpement,
n'hésitez pas à diriger ailleurs au besoin.


apparemment, quand on a besoin de faire un document Markdown pour
indiquer les règles pour permettre les meilleures contributions
possibles,
l'habitude majoritaire pour le nommer est "CONTRIBUTING.md".

est-ce qu'il y a une raison particulière de l'appeler comme ça, plutôt
que "CONTRIBUTE.md", ou même "CONTRIB.md" par ex ?

c'est pour savoir si j'ai un grand intérêt à suivre le mouvement
majoritaire, ou si je peux faire comme je veux dans une certaine mesure.

--
RAPID maintainer
http://savannah.nongnu.org/projects/rapid/

Damien Wyart

unread,
Jan 14, 2022, 10:24:13 AMJan 14
to
* Thomas <fantome.foru...@free.fr.invalid> in fr.comp.developpement:
> apparemment, quand on a besoin de faire un document Markdown pour
> indiquer les règles pour permettre les meilleures contributions
> possibles, l'habitude majoritaire pour le nommer est
> "CONTRIBUTING.md".

> est-ce qu'il y a une raison particulière de l'appeler comme ça, plutôt
> que "CONTRIBUTE.md", ou même "CONTRIB.md" par ex ?

C'est une habitude assez ancienne qui provient des standards Gnu et
Gnits, ainsi que des GNU Autotools. A l'époque, pas de suffixe mais avec
le succès de Github, la rédaction en Markdown est devenue dominante.

Ca n'a pas non plus une importance capitale, après tout, si tu gères un
projet, tu peux faire certaines choses comme tu l'entends... Mais
documente le dans le README (qui, lui, est incontournable) si tu
utilises un nom moins standard ;)

--
DW

Thomas

unread,
Jan 14, 2022, 1:40:54 PMJan 14
to
In article <61e1959b$0$20273$426a...@news.free.fr>,
Damien Wyart <damien...@free.fr> wrote:

> * Thomas <fantome.foru...@free.fr.invalid> in fr.comp.developpement:
> > apparemment, quand on a besoin de faire un document Markdown pour
> > indiquer les règles pour permettre les meilleures contributions
> > possibles, l'habitude majoritaire pour le nommer est
> > "CONTRIBUTING.md".
>
> > est-ce qu'il y a une raison particulière de l'appeler comme ça, plutôt
> > que "CONTRIBUTE.md", ou même "CONTRIB.md" par ex ?
>
> C'est une habitude assez ancienne qui provient des standards Gnu et
> Gnits, ainsi que des GNU Autotools. A l'époque, pas de suffixe mais avec
> le succès de Github, la rédaction en Markdown est devenue dominante.
>
> Ca n'a pas non plus une importance capitale, après tout, si tu gères un
> projet, tu peux faire certaines choses comme tu l'entends...

ok, alors je vais utiliser "CONTRIB", parce que "CONTRIBUTING" je trouve
ça un peu long ...
d'ailleurs c'est de la même longueur que "INSTALL" et "README " ...

> Mais
> documente le dans le README (qui, lui, est incontournable) si tu
> utilises un nom moins standard ;)

aucun pb, c'est déjà fait :-)
http://svn.savannah.gnu.org/viewvc/rapid/branches/gtkada-2.24/README?view
=markup&pathrev=249 ( https://urlpetite.fr/1tx )
(pour l'instant c'est "DEVELOP" parce que j'étais pas au courant des
habitudes)
Reply all
Reply to author
Forward
0 new messages