diff --git a/projects/projects_2024-25/report_Nicolas_Antoine_53511900.md b/projects/projects_2024-25/report_Nicolas_Antoine_53511900.md new file mode 100644 index 0000000000000000000000000000000000000000..c8497b3c58d8771fd5117000c465810e55ae6887 --- /dev/null +++ b/projects/projects_2024-25/report_Nicolas_Antoine_53511900.md @@ -0,0 +1,84 @@ +# **LINFO2401 project report - Contributing to an Open Source project** + +| **Author** | Nicolas Antoine | +| ----------------------- | -------------------------------------------------------------------------------| +| **Date** | 19/11/2024 | +| **NOMA** | 53511900 | +| **Academic Year** | 2024-2025 + | +| **Open Source Project** | [Genome Analyzer](https://github.com/losuy/Genome-Analyser) +| **Open Source Project** | [Mental-Health-Support-Chatbot](https://github.com/Vikranth3140/Mental-Health-Support-Chatbot) +| **Pull request made** | [Update README.md #2](https://github.com/losuy/Genome-Analyser/pull/2) | +| **Pull request made** | [Disclaimer data privacy policy #16](https://github.com/Vikranth3140/Mental-Health-Support-Chatbot/pull/16) | +| **Pull request made** | [Added text size and slight adjustments #17](https://github.com/Vikranth3140/Mental-Health-Support-Chatbot/pull/17) | +| **License** | [MIT License](https://github.com/Vikranth3140/Mental-Health-Support-Chatbot/blob/main/LICENSE)| + +## 1 Introduction + +In the realm of learning about open source strategies for software development, I +have been tasked with finding, understanding, and contributing to an open source +project. This assignment provides an opportunity to dive into the world of open +source. In this report, I will outline my approach, including the specific projects +that I selected, the process of understanding their structures and communities, and +the contributions I made. + +## 2 First Approach + +To contribute to an open source project, the first step is to find one. This proved to +be a challenging task, as I initially had no idea where to start. I realized that I was +not actively using any open source software to which I could contribute, or that I +simply was not aware of such projects. +Through my research, I discovered a helpful resource: the website First Timers +Only, which is designed to guide newcomers to beginner-friendly open source projects +to contribute tohttps://www.firsttimersonly.com/. Exploring various options +on the site led me to a project called GenomeAnalyzer (https://github.com/ +losuy/Genome-Analyser). +The GenomeAnalyzer project is designed to provide a user-friendly software tool +to perform basic genomic data operations, specifically focusing on FASTA files, +which are commonly used to store nucleotide sequences. + +Unfortunately, there was not much to contribute at that time, as the project was +still in its early stages. However, I thought I could help by rearranging its README +file, which was somewhat unclear. My changes focused on clarifying the structure +of the document and making it more accessible for future contributors. + +## 3 Second Approach + +After leaving the GenomeAnalyzer project, I immediately decided to look for another +open source project that would suit me better. I found one called Mental Health Sup- +port Chatbothttps://github.com/Vikranth3140/Mental-Health-Support-Chatbot). +The Mental Health Support Chatbot is an innovative application designed to +provide users with mental health support through an interactive chat interface. +Built using Streamlit and OpenAI’s GPT-3.5-turbo model, this chatbot aims to +facilitate mental well-being by offering personalized assistance and insights. + +There are several issues listed in this open source project, so I jumped in and +tried to resolve one of them. The issue titled â€Add user data privacy notice†fo- +cused on informing users about data handling policies, especially regarding session +persistence. +The very first thing I needed to do was understand the code. Fortunately, it +consisted of only a few files, so I quickly grasped the content and how it achieved +the results I encountered. Here is the code I added to address the issue: + +While discussing my changes and Pull Request (PR) with the project owner, I +felt motivated to contribute even more, so I decided to explore additional ways to +assist the project. + +The feature #12 Improve Accessibility Features tickled my curiosity. This issue +addresses the current shortcomings in accessibility support, which may affect usabil- +ity for users with disabilities. To enhance the user experience, consider implementing +features such as adjustable text sizes. +After many tries, I succeed to obtain something quite satisfying. + +I also improved the quality of the graph to make it clearer and more visually +appealing. + +## 4 Conclusion + +Before starting this course, I had never tried contributing to an open source project. +I always thought it would be too difficult and beyond my skills. However, through +this experience, I learned that it’s not as complicated as I imagined. With some +research and a willingness to learn, I was able to find projects, understand their +structure, and make useful contributions. + +