diff --git a/project.md b/project.md index cbb92b31fe77df4081f5d68a663b3b6d505efcfc..4f81f6d8c2969ce4ba266f186a7caaea6ac8d3e9 100644 --- a/project.md +++ b/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. diff --git a/projects/projects_2024-25/Report-Charles-Edouard-Gervais_65921700.md b/projects/projects_2024-25/Report-Charles-Edouard-Gervais_65921700.md new file mode 100644 index 0000000000000000000000000000000000000000..4e24235785ab905c20c82d7464fd42b0e9d96c74 --- /dev/null +++ b/projects/projects_2024-25/Report-Charles-Edouard-Gervais_65921700.md @@ -0,0 +1,104 @@ +# **LINFO2401 project report - Contributing to an Open Source project** +| **Author:** | _Charles-Edouard Gervais_ | +| ------------------------ | ---------------------------------------- | +| **NOMA:** | 65921700 | +| **Academic Year:** | 2024-2025 | +| **Open Source Projects:** | [Peertube](https://github.com/Chocobozzz/PeerTube) | +| **Pull requests made:** | [Translation](https://weblate.framasoft.org/projects/peertube/angular/#history) | + +## Finding a project +Since I'm very new in the world of Open Source, I kind of struggled finding an interesting project I could bring an usefull contribution to. I indeed spent a lot of time just finding the "sector" I wanted to dive into. + +First of all I wanted to give a contribution in a projet that make sense with a good community. I have simply make my first search on Good First Issue and trying to find something recent. They were so many project but nothing that speaks to me. And when we just click on a project on github we are completely lost. I have join 2 active discord but everytime it s complicated to find a place. + +So i wanted to change my way of searching ... I don t want to find a project with the issues but i wanted to find project where i can find myself. So i just go on facebook and i start to tape key word with open source project and kept thinking about finding something enriching. + +Later in the quadri i find a post of Intersting Engineer that spoke about the project Smart van 2.0 [Smart van](https://github.com/PINTO0309/OpenVINO-YoloV3/pull/78)https://github.com/Smart-Van-2-0 which directly interested me. I got in touch with the owner for knowing if they want some helps or something like that but everything was on point. It s a small project with 3 contributors. + +i really want to contribute to something and i found that very difficult to have the fully comprehension of a repository github with the knowledge of my capacity i wanted to make myself useful with something where i m very good. Translation. + +## Project Selection +With the site framasoft Weblate i found a lot of project that need helps each one more interesting than the other. And then i directly focus on a projet that i had already see on facebook Peertube. + +## Why i chose Peertube + +I chose Peertube because: + + - I have always been interested in the world of video and creating content + - I have already take a look to the github of peertube to trying to fix some issue before but without any success + -The very reactive community with and update everyday and an associated discord + -The kind peer to peer with the interconnected platforms + +## What is Peertube + +PeerTube is a decentralized video hosting platform that provides an alternative to centralized video platforms like YouTube or Vimeo. It is built on free and open-source software and uses a peer-to-peer (P2P) technology for video sharing and distribution. + +Key features + + - Decentralized Network + - Peer-to-peer Streaming + -Open source and Community drive + -No ads or tracking + +## Contribution +As mention before i tried first to fixing some basic issue in the code. To be able to contribute to the project, I obviously had to understand how the code works, read it and look for features to add or improve. After hours of mindblowing I understood that it would be complicated to participate like that. + +Later when i was on the site framasoft Weblate and i saw that peertube was on it it seems like an evidance. I have reach the component angular of the peertube translation with basic vocabulary. + +## Contacting the community +I contacted a member labeled as a Developer and I asked him if I can work on it and do some contribution that can be easy for my first time and he redirected me on the issue relevate that i had already tried. + +## Making the contribution + +I have done all the translation on Framasoft. It s very well explained and easy to use. +All my contribution are in the history. + + +## Journal + +15/10 + +Understanding the open source concept +Joining different group online for open source contribution +Start doing reseach on the interesting topic + +14/11 + +Posting message and facebook and make frequently research with some key word + +26/11 + +Decided to send message and e mail on 4 projects that interested me "Smart Van 2.0" "Project VVV" multiple server discord about VideoGames + +27/11 + +Failed to get any responses from different open source projects +Decided to find an otherwise to contribute + +4/12 + +Finding Peertube and trying to recolabarate and fix some issue on github. +Notify the discord contribution group + +10/12 + +Give up the contribution due to the complexity and the missing of knowledge + +13/12 + +Starting to find the way of translating and begining to do my active contribution + +## Conclusion + +In conclusion, I would say that my main feeling about Open Source is that I am surprised. Indeed, that's my first experience in the world of Open Source and I am suprised about the fact that it went that well. + +I feel like people contributing for free to some kind of project are necessarily nice since they just do it by pure pleasure. Everyone helps everyone without judgment with the common interest of wanting to improve the same project. + +I'm also suprised to see how fast a project can grow when there are multiple contributors ready to put effort in it. Indeed every day there are some peoples who want to advance in the project. + +I'm glad I was part of such an experience at least once in my IT career because I really felt like being actually useful to a project that will itself be useful in the future. + +Though, as said earlier, I'm kind of frustrated about the fact that I couldn't help trully with the code but only in surface. But right know i have more idea of the fonctionnement of peertube and i will be glade to use it and share it ! + +To finish, I noticed that my knowledge about git and all its usages are lower than what I thought. Knowing that, I will do my best to fix that in order to be more prepared in the future. + diff --git a/projects/projects_2024-25/Report-Heloise-CordiClaes-35111900.md b/projects/projects_2024-25/Report-Heloise-CordiClaes-35111900.md index 25382c8e95562cb47afe14de97f88b86e004f67e..0ac4b9c4b75e240af22cd6a67671a7ce622eafe3 100644 --- a/projects/projects_2024-25/Report-Heloise-CordiClaes-35111900.md +++ b/projects/projects_2024-25/Report-Heloise-CordiClaes-35111900.md @@ -6,7 +6,7 @@ | **Academic Year:** | 2024-2025 | | **Date:** | 09/12/2024 | | **Open Source Project:** | [Scribe-iOS](https://github.com/scribe-org/Scribe-iOS)| -| **Pull request made:** | [PR#520]| +| **Pull request made:** | [PR#524]| | **License** | [ GPL-3.0 license ](https://github.com/scribe-org/Scribe-iOS?tab=GPL-3.0-1-ov-file#readme) | @@ -30,16 +30,18 @@ Second I had to make myself comfortable with the swift language that I've never ### **Choosing the issue** As I asked the community to tell me which issue I could contribute to. I was attributed to 2 different issues. The first one was to add some basics tests to test different functionnalities, the second one is to switch all language references in code to ISO-2 codes. -I worked first with the first one, that was accepted to be merge. But I'm still working on the second issue. +I worked first with the first one PR #520, that an owner told me as fine, but finally there was mistakes in my file, and after few private chat with him, I decided to fully focus on the second issue (#494). ### **Implementation** -I've implemented a new file with some tests, using different functionalities as the plural of nouns, or translation. +So, I've first implemented a new file with some tests, using different functionalities as the plural of nouns, or translation. As I said, that was finally not accepted due to problems with matching the tests and the app. +I secondly implemented modifications in 15 different files, to switch most of language references to ISO-2 codes, in response to issue #494. For example, I had to change change EnglishVariable into enVariable or FrenchVariable into frVariable, and so on with every variables or functions named with that type. I had then to rearrange and check the calls of theses variables, to see if that was not bringing new bugs or issues. ## **Lessons learned** I've learned lot of different things during the project : * I learned how to search for an helping contribution. * I have new skills now on how to make pull request with a project that I didn't know at first. +* I developed also my skills with the command line to 'play' with a github repository. * Reading thoroughly other pull requests tells what maintainers expect and saves everybody time. * Understanding the context of why a license is chosen is essential. diff --git a/projects/projects_2024-25/Report-Lorenzo-DIntinoSalgado-80281900 .md b/projects/projects_2024-25/Report-Lorenzo-DIntinoSalgado-80281900 .md new file mode 100644 index 0000000000000000000000000000000000000000..7618426c398c31df4f64240147a062862f77967e --- /dev/null +++ b/projects/projects_2024-25/Report-Lorenzo-DIntinoSalgado-80281900 .md @@ -0,0 +1,66 @@ +# **LINFO2401 Contributing To An Open Source Project - Report** + +| **Author** | Lorenzo D'Intino Salgado | +| ------------------------ | -------------------------------------------------------------------------------------------| +| **NOMA** | 80281900 | +| **Academic Year** | 2024-2025 | +| **Open Source Project** | https://github.com/TheAlgorithms/Python +| **License** | [MIT License] https://github.com/TheAlgorithms/Python/blob/master/LICENSE.md | | +| **Pull request** | https://github.com/TheAlgorithms/Python/pull/12372 | + + + +## Project Selection +At first I didn't know what to do, so I started by scrolling through all the previous project contributions. I finally came across the Algorith project. There are several versions of the project written in different languages, but I chose the one written in Python. + +## The Contribution +After browsing through all the files, I decided to contribute to the K-means algorithm. After running the code, I wanted to add the K-means++ extension, which in theory should improve its performance. Unfortunately, it didn't yield the results I expected and I had difficulty fixing it. Finally, for debugging purposes, I made a 3D plot of the final clustering results, which seemed to be a better contribution than my first proposal. + +## Pull Request +Once I had implemented my code locally, I followed the Contribution Guidlindes (CG) witch asks to install and run the pre-commit plugin, which runs some automatic tests to ensure that everything is alwrite in our submision. I made the mistake of only test the file I was modifying and not the whole project. This resulted in my PR having the tag "tests are failing". The bug was coming from another file, and I added a commit to fix it. The next day, the main contributor for the project made a commit to fix the bug (https://github.com/TheAlgorithms/Python/commit/e3f3d668be4ada7aee82eea0bc75c50436c1ab3a) with made my fix uselles. I decided to close my pull request and open a new one widout the bug fixing. + +After a few weeks of not getting any feedback from the main contributors, I thought the best thing to do would be to post a message on the project's Discord. Eventually I decided not to do so, as the server was mostly filled with people asking to have their PR reviewed (and the owners telling them that they were understaffed and didn't have time for it), or random messages that had nothing to do with the project. + +## Diary: + +| 28/10/2024 | +|-----------------------| +- Check previous students' open source projects contributions. +- Finding the Algothm project. + +|-----------------------| +| 30/10/2024 | +|-----------------------| +- Exploring the project and deciding to contribute to the K-means algorithm. + +|-----------------------| +| 04/09/2024 | +|-----------------------| +- Start to code the K-means++ extention. + +|-----------------------| +| 09/10/2024 | +|-----------------------| +- Changing course and implementing a 3D plot of the K-means final result. +- Publishing my first PR!! But flagged as "tests are failing" :pensive: +- Adding a fix to the bug. + +|-----------------------| +| 11/10/2024 | +|-----------------------| +- Main Contributor committing a fix for the bug I was experiencing. + +|-----------------------| +| 12/10/2024 | +|-----------------------| +- Publishing my second PR free of bugs. + +|-----------------------| +| PRESENT | +|-----------------------| +- Still waiting for my PR to be acknowledged. + + + + + diff --git a/projects/projects_2024-25/Report-Louis-De-Wilde_31622300.md b/projects/projects_2024-25/Report-Louis-De-Wilde_31622300.md new file mode 100644 index 0000000000000000000000000000000000000000..f87a2b034c149f90df1cc37970cbda9f9ebd4f40 --- /dev/null +++ b/projects/projects_2024-25/Report-Louis-De-Wilde_31622300.md @@ -0,0 +1,53 @@ +# **LINFO2401 Project Report : Contributing to an Open Source project** +--- + +| **Author** | Louis De Wilde +| +| ------------------------ | -------------------------------------------------------------------------------| +| **Date** | 16/12/2024 | +| **NOMA** | 3162-23-00 | +| **Academic Year** | 2024-2025 | +| **Open Source Project** | [Factoriolab](https://github.com/factoriolab/factoriolab) | +| **Pull request made** | [fix: Adding french translations #1663 ](https://github.com/factoriolab/factoriolab/pull/1663)| +| **License** | [MIT Licence](https://github.com/factoriolab/factoriolab?tab=MIT-1-ov-file#readme) | + +## Project Description + +Factoriolab is a factory planner for Factorio and other factory games. If you have never heard of Factorio or factory games, these are video games where the player constructs, automates, and exploits their environment by building factories. Factoriolab helps players plan a factory based on a goal throughput. + +## Project Choice + +I have been playing Factorio for more than 550 hours and used Factoriolab to plan nearly all of my factories. When I was searching for an open-source project to contribute to, I found out that Factoriolab was open source. I checked out the repository and discovered that it was very active. +Technical Details About the Project and Contributors + +The project is maintained by dcbroad3 and has 42 contributors, 591 stars, and more than 700 commits. + +Factoriolab is written in Angular and is hosted at factoriolab.github.io. A self-hostable release is also available on the GitHub release page, with the latest release at the time of writing being v3.8.8. + +The project is organized around GitHub for code management and Discord for more informal communication. + +## Contribution Process + +When I started contributing, I looked at the issues and feature suggestions on GitHub and the Discord tracker. I then tried to understand the inner workings of the web app. Since I am quite familiar with Angular, I initially thought it wouldn’t take much time, but I largely underestimated the project’s complexity. The project is intricate due to its support for multiple games, multiple versions of each game, and mods for those games. + +As the deadline for completing my pull request approached, I shifted my focus to translations, thinking it would be an easier way to get started. + +After exploring the codebase further to understand how translations were implemented, I realized that translations were managed through a JSON file where each key corresponds to a word or string used on the site. + +There was a slight issue with the JSON approach: I needed to get the correct key from the en.json file, which was complete, but it was not easy to determine what was and wasn’t already present in the fr.json file. + +After some consideration, I implemented a simple TypeScript script to compare the source JSON file with the target language's JSON file and prompt me to translate the missing keys. + +After running the script and translating 150 keys, I saved the file and made an initial commit of the translations, followed by a pull request. + +Since this was non-technical work, I didn’t think to run or build the project. This came back to bite me when the GitHub Continuous Integration workflow failed during the Prettier phase. + +I then fixed the issue, which was caused by tabs being two spaces instead of four, and committed the fix. + +In my pull request, I mentioned the script, and the project maintainer was interested. We had a brief chat about its features. I mentioned that the script still needed some TLC and promised to make another pull request later. + +dcbroad3 subsequently merged my pull request into the main branch. + +## Conclusion + +In conclusion, I would say that contributing to this project was a great experience, and I plan to make more technical contributions in the future. diff --git a/projects/projects_2024-25/Report-Romain-Spanhove-03842410.md b/projects/projects_2024-25/Report-Romain-Spanhove-03842410.md new file mode 100644 index 0000000000000000000000000000000000000000..b72cc02124d6f953470bb8fbcbe583dd6e97cdc6 --- /dev/null +++ b/projects/projects_2024-25/Report-Romain-Spanhove-03842410.md @@ -0,0 +1,73 @@ +# **LINFO2401 Project Report - Contributing to an Open Source Project** + +| **Author:** | Romain Spanhove | +| ------------------------ | ---------------------------------------- | +| **NOMA:** | 03842410 | +| **Academic Year:** | 2024-2025 | +| **Open Source Project:** | [Mekanism](https://https://github.com/mekanism/Mekanism) | +| **Contribution:** | French translation on [Crowdin](https://crowdin.com/project/mekanism/activity-stream)<br>Typos fixing: [Pull request](https://github.com/mekanism/Mekanism/pull/8274)| +| **License** | [MIT License](https://https://github.com/mekanism/Mekanism/blob/1.21.x/LICENSE)| + +## Project Description + +Mekanism is a popular open-source tech mod for the Java version of Minecraft, focusing on automation through advanced machinery and energy systems. Mekanism: Tools is a sub-mod that adds new gear. + +The first commit was made by Aidan Brady (aidancbrady) on the 15th of August, 2012. +The project currently has 1,406 stars, 534 forks, 10,398 contributions from 138 people. + +### Maintainers +There is currently 3 maintainers: +- Aidan (aidancbrady) +- Sara Freimer (pupnewfster) +- Xander (thiakil) + +### License + +The MIT License is an open-source license that allows users to freely use, modify, and distribute software. It places minimal restrictions, requiring only that the original copyright and license notice be included in copies of the software. + +## Project Search + +| October | +|-----------------------| + +The first step was to find a project to participate in. I don't typically use open-source projects in my daily life, except for some widely used ones like Thunderbird or the LibreOffice suite. + +To explore some options, I checked out projects from previous years. I found someone who had contributed to the Mekanism Minecraft mod. Growing up with Minecraft and playing the game with mods during this summer, this seemed like the perfect opportunity to get find an open-source project. + +## First attempt + +| 08/11/2024 | +|-----------------------| + +I was looking for a Minecraft mod where I could help with French translation or implement/fix a simple feature that I would enjoy. I came across the mod Sophisticated Backpacks, which I had used during the summer. It's not overly complex, and I'm familiar with most of the mod, so I thought it would be a good place to start. + +| 16/11/2024 | +|-----------------------| + +While considering the translation, I decided it would be better to first try to compile the mod on my computer. That is when I ran into some difficulties and noticed the relative simplicity of the README (which only mentioned the Discussions tab on GitHub). It seemed like there was too little information, and the only link was to CurseForge (a popular platform for sharing Minecraft mods) which I hadn’t considered earlier, thinking I wouldn't find any useful information there. + +But that is where I found the mod’s Discord. I learned that the French translation had already been completed but hadn’t been pushed to the default branch of the GitHub repository, but it was on a more recent one. Since Minecraft mods are available for multiple versions of the game, the default branch wasn’t using the latest Minecraft version (although it is now) and so it didn't include the latest implementations. + +## Second attempt + +| 09/12/2024 | +|-----------------------| + +Since the task I originally wanted to do was already completed, I decided to look for another project to contribute to. I returned to my initial idea: the Mekanism mod. The French translation was incomplete, so I decided to contribute. + +| 16/12/2024 | +|-----------------------| + +On the Crowdin platform, I translated most (~90%) of the sub-mod Mekanism: Tools, which amounted to about 4,200 words and 750 translations. +While searching for references in the game, I also found that the Minecraft launcher translation is hosted on Crowdin, something I would not have noticed without this project. + +I also noticed some typos in the original files, so I created a pull request to fix them. The request is still pending, as I’m writing this just after submitting it. + + +## Conclusion + +This project allowed me to discover and become interested in the open-source projects I use. It also made me realize that participating in a project can be easy and that it is quite satisfying to contribute to a project that you know and use. + +It also helped me better understand the necessary steps before starting a new project. Indeed, searching for information about the community around the project and its organization greatly facilitates the process, as does reading the documentation and installing the project on your machine. + +This is not something I would have taken the time to do under normal circumstances, as I don’t tend to interact much with others on the internet, so I am grateful for the opportunity provided by the course. \ No newline at end of file diff --git a/projects/projects_2024-25/Report_Norman_Piryns_352201.md b/projects/projects_2024-25/Report_Norman_Piryns_352201.md new file mode 100644 index 0000000000000000000000000000000000000000..954eb00543c339de0db8f05195a6e5fcaf58061d --- /dev/null +++ b/projects/projects_2024-25/Report_Norman_Piryns_352201.md @@ -0,0 +1,35 @@ +# **LINFO2401 Project Report : Contributing to an Open Source project** +--- + +| **Author** | Norman Piryns | +| ------------------------ | -------------------------------------------------------------------------------| +| **Date** | 16/12/2024 | +| **NOMA** | 00352201 | +| **Academic Year** | 2024-2025 | +| **Open Source Project** | [BgGPT](https://github.com/insait-institute/BgGPT/) | +| **Pull request made** | [ Added Readme.md #9 ](https://github.com/insait-institute/BgGPT/pull/9) | +| **License** | [MIT Licence](https://github.com/insait-institute/BgGPT/blob/master/LICENSE) | + +## Project Description + +BgGPT is the new bulgarian alternative to ChatGPT. It performs better than other LLMs in bulgarian language all while being on par in english with other known services. It's developped by INSAIT, a known AI research institute, situated in Sofia, Bulgaria, combining talent from ETH Zurich, EPFL, Sofia University and more. + +## Project hunting process + +First of all, I started exploring projects that were connected to my interests. Given that I have developped mobile apps with maps in the past, I decided to take a look at [OpenStreetMap](https://github.com/gravitystorm/openstreetmap-carto). However, the project is extremely large, layered, and hard to digest, so I had no clear idea how I could make a contribution. Then I skimmed through other projects I could make translations to (like React.js, MDN Docs, ...), as I know that this is something that can always be improved on, but I did not find what I was looking for. Following that, I took a look at plenty of random repositories, issues, and also dove into more unconventional projects, like adding a new feature to an esoteric programming language. I stumbled upon [spookyc](https://github.com/normanpiryns/spookyc), which is a programming language which is supposed to scare you (I know Halloween is behind us). It looked fun at first, but I didn't manage to make it function locally. I wanted to get a basic understanding of it and implement some new tests. It seemed depreciated, due to lack of maintenance (to be expected, given that it has not been active since 7 years). Later on, I started browsing repositories of things I know and discovered that INSAIT had their own repos and saw there was no README, and thought it would be a suitable addition, even though it is non-technical and does not help the project in any way outside of marketing. It is unfortunate that I could not solve an actual problem, but I got the gist of how I can make a better impact in the future. + + +## My contribution + +A simple informative README about the BgGPT project in bulgarian language. I opened the pull request and wait for a potential merge. Due to the low priority of the task, I did not insist on contacting the owners and getting this through, but if it was a more relevant feature, I would have insisted on more feedback and iterate on it. + +## Local Fork + +https://github.com/normanpiryns/BgGPT/tree/readme + + +## Reflections + +In conclusion, I believe contributing to an open source project is more than just going online and writing a line of code, but being an active part of a community that builds the project together and is engaged with its evolution. + +I underestimated the effort it takes to find a bite-sized but active project that runs locally, but I think that as I increase my engagement with the software engineering world, I will be able to build more significant features to existing projects. diff --git a/projects/projects_2024-25/report-Aymeric-Peten-78272000.md b/projects/projects_2024-25/report-Aymeric-Peten-78272000.md new file mode 100644 index 0000000000000000000000000000000000000000..31b9e592bbee45b0e7c0fb395953f3f2648288bf --- /dev/null +++ b/projects/projects_2024-25/report-Aymeric-Peten-78272000.md @@ -0,0 +1,51 @@ +# 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 diff --git a/resources.md b/resources.md index c8c02a2deccfce02801e76a1f21e68299d1cee1b..2209bf8600473e90e54f34078151248e207566a4 100644 --- a/resources.md +++ b/resources.md @@ -7,3 +7,9 @@ ### General open source - https://www.linuxfoundation.org/ + +### Learning CLI + +- [MIT Missing Semester](https://missing.csail.mit.edu/) An introductory course to equip students with crucial practical skills. [French-only version](https://moodle.uclouvain.be/course/view.php?id=9311) +- [Linux Jurney](https://linuxjourney.com/) An interactive guide to Linux, it's ecosystems and the CLI +- [Learn Git Branching](https://learngitbranching.js.org/) An interactive web-based course to learn `git` with the CLI. diff --git a/syllabus/notes b/syllabus/notes index 65e997ee574a5ad54ce15c29e16a41fb6e6a14b2..8661f83fe552c7104f5c34979b8aac1513fc0faa 100644 --- a/syllabus/notes +++ b/syllabus/notes @@ -1,3 +1,7 @@ Explication de la backdoor XZ en mars 2024: https://piaille.fr/@rusty/112190942173039817 + + +People who don’t read books are sleepwalking through their entire career: +https://ludic.mataroa.blog/blog/you-must-read-at-least-one-book-to-ride/