diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md new file mode 100644 index 0000000..a6a5efc --- /dev/null +++ b/doc/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contribute to the M82 bibliography + +## About + +This tutorial details how to contribute to the M82 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) \ No newline at end of file