Merge pull request #4 from sebdraven/main

add doc for contributing

README.md

@@ -1,5 +1,7 @@
 # Bibliography
 
+## Purpose
+
 Hello, here is an attempt to establish a shared bibliography in BibTex format (to facilitate exports to Zotero :)) Thank you for contributing by respecting the formalism below.
 
 Bonjour, voici une tentative d'établir une bibliographie partagée en format BibTex (pour faciliter les exports vers Zotero :))
@@ -25,3 +27,11 @@ isbn = {}}
 ```
 
 Want to know more about BibTeX ? => <https://www.bibtex.com/g/bibtex-format/>
+
+## How to contribute
+
+If you want to contribute to this bibliography, you can follow this [tutorial](./doc/CONTRIBUTING.md).
+
+## Comment participer
+
+Si vous souhaitez participer à cette bibliographie, vous pouvez suivre ce [tutoriel](./doc/CONTRIBUER.md).

doc/CONTRIBUER.md

@@ -0,0 +1,72 @@
+
+# Contribuer à la bibliographie M82
+
+## À propos
+
+Ce tutoriel détaille comment participer à la bibliographie M82.
+
+<https://github.com/BartM82/Bibliography>
+
+Le seul pré requis est d’avoir un compte Github.
+
+## Procédure de participation
+
+Pour participer à la bibliographie :
+
+1. Aller sur le lien de la bibliographie.
+2. Si vous n’avez jamais participé, cliquer sur *fork*.
+
+![79b1a3f736153dd07b851f06cd57d0f9.png](./_resources/79b1a3f736153dd07b851f06cd57d0f9.png)
+
+![9d091cec81a6711d5e075795b5db6750.png](./_resources/9d091cec81a6711d5e075795b5db6750.png)
+4. Si vous avez déjà participé, cliquer sur *Sync Fork* dans votre répertoire à vous.
+
+![3f99e75b94d11af39f56af8a82caecd5.png](./_resources/3f99e75b94d11af39f56af8a82caecd5.png)
+5. Cliquer sur *Create for*
+![4812be885874583298089d36599036d6.png](./_resources/4812be885874583298089d36599036d6.png)
+
+Vous pouvez ajouter, modifier, ou supprimer des fichiers.
+
+Pour modifier du contenu :
+
+1. Cliquer sur un fichier (ici mars 2023).
+2. Cliquer sur *edit file*.
+
+![184328df1eb3966c63ceaba2bdf04c8e.png](./_resources/184328df1eb3966c63ceaba2bdf04c8e.png)
+
+Ici, on modifie le nom du fichier pour normaliser.
+![4099833a1f8c3dbb2bec64113935c469.png](./_resources/4099833a1f8c3dbb2bec64113935c469.png)
+
+Une fois la modification faite, en bas de la page,
+vous devez cliquer sur *Commit changes*. Vous pouvez ajouter un commentaire.
+
+![16c3bb2db7bac3ff2c89cf506a5f6c40.png](./_resources/16c3bb2db7bac3ff2c89cf506a5f6c40.png)
+
+Une fois les modifications faites,
+
+![b20829f4c4d24306104d42fc31927e35.png](./_resources/b20829f4c4d24306104d42fc31927e35.png)
+
+vous pouvez maintenant demander l’application de vos modifications en cliquant sur *Contribute*.
+
+![fec302159359c358ff9d40ce10578dcd.png](./_resources/fec302159359c358ff9d40ce10578dcd.png)
+
+![75bc414cc067f66a7b81abb1868cb30c.png](./_resources/75bc414cc067f66a7b81abb1868cb30c.png)
+
+Cliquer sur *Open pull request*.
+
+S’il n’y a pas de conflits, le message en vert *able to merge est présent*.
+
+![c46228eb3b6fc2fd47dea95053785468.png](./_resources/c46228eb3b6fc2fd47dea95053785468.png)
+
+* Ajouter un titre.
+* Vous pouvez ajouter des commentaires pour préciser l’ensemble de vos modifications.
+
+Et cliquer sur *Create Pull Request*.
+
+![37b903a64d60f502a38fb2b0295b7d25.png](./_resources/37b903a64d60f502a38fb2b0295b7d25.png)
+
+Comme une revue doit être effectuée, il faut attendre qu’un relecteur approuve les modifications.
+
+Une fois approuvée, vous recevez un message et le statut change :
+
+![7a2c2a7dcb99d7ab6df15e1f7658e346.png](./_resources/7a2c2a7dcb99d7ab6df15e1f7658e346.png)

doc/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contribute to the M82 bibliography
+
+## About
+
+This tutorial details how to contribute to the M82 bibliography.
+
+<https://github.com/BartM82/Bibliography>
+
+The only prerequisite is to have a Github account.
+
+## How to participate
+
+To participate in the bibliography:
+
+1. Click on the bibliography link.
+2. If you have never contributed before, click on *fork*.
+
+![79b1a3f736153dd07b851f06cd57d0f9.png](./_resources/79b1a3f736153dd07b851f06cd57d0f9.png)
+
+![9d091cec81a6711d5e075795b5db6750.png](./_resources/9d091cec81a6711d5e075795b5db6750.png)
+4. If you have already contributed, click on *Sync Fork* in your own directory.
+
+![3f99e75b94d11af39f56af8a82caecd5.png](./_resources/3f99e75b94d11af39f56af8a82caecd5.png)
+5. Click on *Create for*.
+![4812be885874583298089d36599036d6.png](./_resources/4812be885874583298089d36599036d6.png)
+
+You can add, modify, or delete files.
+
+To edit content :
+
+1. Click on a file (here March 2023).
+2. Click on *edit file*.
+
+![184328df1eb3966c63ceaba2bdf04c8e.png](./_resources/184328df1eb3966c63ceaba2bdf04c8e.png)
+
+Here we change the file name to normalize.
+![4099833a1f8c3dbb2bec64113935c469.png](./_resources/4099833a1f8c3dbb2bec64113935c469.png)
+
+Once the modification is done, at the bottom of the page,
+you must click on *Commit changes*. You can add a comment.
+
+![16c3bb2db7bac3ff2c89cf506a5f6c40.png](./_resources/16c3bb2db7bac3ff2c89cf506a5f6c40.png)
+
+Once the changes are committed,
+
+![b20829f4c4d24306104d42fc31927e35.png](./_resources/b20829f4c4d24306104d42fc31927e35.png)
+
+you can now request that your changes be applied by clicking on *Contribute*.
+
+![fec302159359c358ff9d40ce10578dcd.png](./_resources/fec302159359c358ff9d40ce10578dcd.png)
+
+![75bc414cc067f66a7b81abb1868cb30c.png](./_resources/75bc414cc067f66a7b81abb1868cb30c.png)
+
+Click on *Open pull request*.
+
+If there are no conflicts, the label *able to merge message* is present.
+
+![c46228eb3b6fc2fd47dea95053785468.png](./_resources/c46228eb3b6fc2fd47dea95053785468.png)
+
+* Add a title.
+* You can add comments to clarify all your changes.
+
+And click on *Create Pull Request*.
+
+![37b903a64d60f502a38fb2b0295b7d25.png](./_resources/37b903a64d60f502a38fb2b0295b7d25.png)
+
+As a review has to be done, you have to wait for a reviewer to approve the commits.
+
+Once approved, you receive a message and the status changes:
+
+![7a2c2a7dcb99d7ab6df15e1f7658e346.png](./_resources/7a2c2a7dcb99d7ab6df15e1f7658e346.png)