Preparer le code et sa documentation pour une mise en open-source

philharmoniedeparis / metascore-library

The front-end library that powers the metaScore authoring tool.

https://metascore.philharmoniedeparis.fr

CeCILL Free Software License Agreement v2.1

0 stars 0 forks source link

Preparer le code et sa documentation pour une mise en open-source #588

Open semiaddict opened 1 year ago

semiaddict commented 1 year ago

J'ai mis à jour le README et ajouté un journal des modifications (généré automatiquement) dans la branch chore/588--prepare-opensource).

@rbailly, le texte du README te convient-il ?

semiaddict commented 1 year ago

J'ai également ajouté un guide de contribution.

semiaddict commented 1 year ago

Je compte aussi simplifier le signalement des bogues ou des demandes de fonctionnalités par la mise en place de modèles de formulaires github. Vous pouvez les tester ce que j'ai pour l'instant en allant sur https://github.com/semiaddict/issue-templates-test/issues/new/choose. Est-ce OK pour vous ?

semiaddict commented 1 year ago

Comme le public actuel de metaScore est majoritairement francophone, je me demande si nous ne devrions pas ajouter des modèles de formulaires en français et traduire les textes du readme et du guide de ontribution.

semiaddict commented 1 year ago

Voici des exemples de deux manières distinctes de traiter les fichiers README multilingues :

des fichiers séparés avec des liens en haut de chaque fichier : https://github.com/jonatasemidio/multilanguage-readme-pattern
un seul fichier avec chaque section traduite : https://github.com/PyvesB/alexa-revolutionary-calendar

Personnellement, je préfère la première solution.