Merge branch 'master' into 'master'

Report-Louis-De-Wilde_3162300

See merge request ldricot/lingi2401!389

projects/projects_2024-25/Report-Louis-De-Wilde_31622300.md

+# **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.