Merge branch 'master' into 'master'

Report Aymeric Peten

See merge request ldricot/lingi2401!388

project.md

@@ -37,7 +37,7 @@ First, you will have to deal with other people. You will need patience. So start
 3. Explore the software you use and try to find if there are any opensource. Discuss with others.
 4. Once you found an interesting project, git checkout and try to build it locally. You have succeeded only if you can run the version you compiled yourself. This part might be trivial or be really hard, depending on the project. If it’s hard, consider contributing to the documentation to make it easier.
 5. Make a trivial change in the project to ensure you can modify the code and run it. Congratulations, you made it!
-6. If you made it so fare, explore the bug tracker to see what you could do. Most projects have "easy" bugs kept for beginners. Try to contact the community on the chat or the forum. Try to understand who is doing what. See if the project is active. Does it make sense to contributed to a project without any activity for years? (sometimes, yes, but better check beforehand)
+6. If you made it so far, explore the bug tracker to see what you could do. Most projects have "easy" bugs kept for beginners. Try to contact the community on the chat or the forum. Try to understand who is doing what. See if the project is active. Does it make sense to contributed to a project without any activity for years? (sometimes, yes, but better check beforehand)
 7. Code
 8. Submit your Pull Request (PR)
 9. Get feedbacks, fix your code and go back to 7 while not accepted.

projects/projects_2024-25/report-Aymeric-Peten-78272000.md

+# LINFO2401 project report - Contributing to an Open Source project
+
+| **Author**              | Aymeric Peten                                                                           |
+| ----------------------- | --------------------------------------------------------------------------------------- |
+| **Date**                | 16/12/2024                                                                              |
+| **NOMA**                | 78272000                                                                                |
+| **Academic Year**       | 2024-2025                                                                               |
+| **Open Source Project** | [tldr](https://github.com/tldr-pages/tldr)                                              |
+| **License**             | [MIT License \& CC-BY](https://github.com/tldr-pages/tldr?tab=License-1-ov-file#readme) |
+| **Pull request**        | [Pull Request #15161](https://github.com/tldr-pages/tldr/pull/15161)                    |
+| **Issue**               | [#14996](https://github.com/tldr-pages/tldr/issues/14996)                               |
+ 
+## **Project Selection**
+At first I wanted to contribute to a project that I use constantly, with whose community I had already interacted: [Autoraise](https://github.com/sbmpost/AutoRaise). It is a project maintained by a single person, and he was very active when I interacted with that community. However, there were a few issues:
+- The project was not active at all during this semester, which is one of the main project guidelines.
+- I had a few ideas of things to do, but it seems that the author had become a bit [scared of adding new functionnality](https://github.com/sbmpost/AutoRaise/issues/211#issuecomment-2126596818).
+- It was a "dictatorship repo", I felt there might be more interesting projects to contribute to for this course.
+
+So after looking around for a while I settled on tldr, as it is something I use quite a lot, that is a large project, whith a very different governance model than Autoraise.
+(In case you don't know, tldr is a collection of simplified and community made alternative to man pages, that are better to get a quick grasp of a command/ with frequent examples).
+
+
+## **Project Data**
+- Number of members: 25
+- Number of stars: 52k
+- Number of forks: 4.3k
+
+## **Contribution Process**
+There were two CLI utilities that didn't have tldr pages. So I took it upon myself to write them.
+There is a nice [contribution guide](https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md). So i followed it, and I quickly had two pages i thought were final.
+
+I also found an issue, that was simply somebody that [tried](https://github.com/tldr-pages/tldr/issues/14996) to contribute a page modification, but didn't follow the style guide. Nobody had answered him, so I did, and modified his page so that it fit the guidelines and added that to my PR.
+
+I thought my pages were final and were gonna be approved quickly.<br>
+I was wrong. I made 18 more commits. There was a typo I left in one of the pages, but mostly, even though I followed the style guide, there were still a lot of changes suggested by the maintainers. 
+All of them were valid from my point of view, but I hadn't thought of them for 2 reasons:
+- What I tought of as tldr pages was not exactly what the maintainers thought of as tldr pages. <br>
+    They don't want to document installation methods, which is something I thought made sense for autoraise, since it is a large part of the usage of the usage of that app/CLI utility.
+- Most other change requests were about the style of the pages. <br>
+    I agree with them, but I felt that a bit of back and forth could have been avoided if the style guide was a bit more detailed. Though I understand that it may be hard to write a clear and concise style guide. (looking around, I saw that it is [in progress](https://github.com/orgs/tldr-pages/projects/1/views/1)).
+
+
+
+
+## **Conclusion**
+Now that I have done my contribution in a large project, I see that there really is a lot going into making an open source project contribution friendly. Even when talking about .md files, you need to check if it fits, if it does indeed compile, if the info is relevant & useful according to your guidelines. In this project, they even have a linting tool to check if contributions are well formatted. 
+I'd like to delve deeper in the management aspect of this community, but it's something that I wasn't able to do during this project.
+
+Overall, I'm not especially happy with my contribution as it is not as useful as I thought it would be, but I am definitly glad I got a hands on experience of what was said during the lesson, giving me interesting insight of the workings of larger coding projects whether it be a professionnal, an opensource or both.<br>
+Speaking of large projects, this one also changed my view on OS projects in general, as I had only seen/interacted with small project(see [Project Selection](#project-selection)).
+Also I'm pretty sure that the next time I type the tldr command and there is no page, I'll contribute, as it is something that has helped me.
\ No newline at end of file