Skip to content
Extraits de code Groupes Projets
Valider 96721b6c rédigé par Lionel Dricot's avatar Lionel Dricot
Parcourir les fichiers

Merge branch 'cbakashika-master-patch-63007' into 'master'

Report_Chris_Bakashika_79601800.md

See merge request ldricot/lingi2401!366
parents d8657311 ca2e9e84
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
# **LINFO2401 project report - Contributing to an Open Source project**
| **Author** | Chris Bakashika |
| ----------------------- | -----------------------------------------------------------------------------------------------|
| **Date** | 30/11/2024 |
| **NOMA** | 7960-1800 |
| **Academic Year** | 2024-2025 |
| **Open Source Project** | [PythonBrokenEnglish](https://github.com/PythonEducationVid/PythonBrokenEnglish) |
| **Pull request made** | [Python command-line argument video (sys.argv) #141 #143](https://github.com/PythonEducationVid/PythonBrokenEnglish/pull/143) |
| **License** | [MIT License](https://github.com/PythonEducationVid/PythonBrokenEnglish/blob/main/LICENSE) |
## Project: PythonBrokenEnglish
PythonBrokenEnglish is a Python Language Learning Project. The idea of this project is to enhance language learning through various multimedia resources. The project is designed not only to assist learners in understanding and speaking English, particularly for non-native speakers, but also to provide video tutorials in their native languages to learn coding in Python.
The project provides audio materials, example scripts, and instructional videos, it aims to facilitate language acquisition in an engaging and effective manner.
The Python Language Learning Project is designed to provide learners with resources that cater to different languages, including Hausa(Chad), Igbo(Nigeria), Yoruba(West Africa), and English. This project offers:
- Audio Resources: Designed for practicing English and native languages.
- Tutorial Scripts: Practical scripts to help learners engage with the language in both English and their native tongue.
- Instructional Videos: Visual content that explains concepts in users' native languages, making learning more accessible.
It currently has 2 stars, 10 forks, 136 active issues and 0 closed for the moment. There are 6 contributors in the project (including me).
The owner and maintainer of this project is Ntem Kenyor, I joined him through is mail address and He is pretty much accessible, so It's easy to get in touch with him quickly. I thing that can be explained by the fact that for the moment there aren't many contributors to the project so it's easy for him to handle the conversation quickly, This kind of small projects are pretty well adapted for first contributions.
I haven't seen any disucssion forum or anything like that. For the moment I've observed that the only convnersations between users and/or contributors happen in issues or PR.
To talk about the License, the project is under **MIT License**, a permissive open-source license that allows users to freely use, modify, and distribute the software, even for commercial purposes, as long as the original copyright notice and license terms are included in any copies or substantial portions of the software.
It's my first Contribution to PythonBrokenEnglish, I discovered this project by diging into GitHub Open Source Project were Python is used.
## Contribution
The project just need a Python installation on your machine and an IDE to run sample of code in the videos. It also has a `CONTRIBUTING.md` file which helped me pretty well to know how I can start the process of contribution to the project.
When I understood, how the project was built, I first dig into the issues to see what's going on. I've found that in fact in this project the majority of issues are written by the owner and maintainer, Ntem Kenyor. In this issues, He clearly describes what kind of videos he wants to be made, the subject which it talks about which is a Python functionality, and He provides the script python that needs to be explained in the video.
By doing so, You just have to know Python programmation and to be able to transmit the explanation of the script to the viewers in a video.
The contribution took me one week to be done because eveything was pretty well explained and I understood pretty well how to interact with the community. Because I messed up a contribution on **Bokeh**(https://github.com/bokeh/bokeh) project which I was trying to build since 3 weeks. I started very bad by posting huge piece of code, unrelated subject connection and I thing that It was a big mistake beacause one of the owner just stopped to answer me.
I didn't wanted to make the same error in this BrokenEnglishProject.
When I found an interesting issue which I was able to solve, I recorded the video in good quality in an instructional way to explain the piece of Python script that the issue was talking about.
Then I have made a PR explaining that I have made a video and in my PR I referenced the orginal issue so that the owner can directly know to what It's related.
The same day I've sent an email to the owner of the project, to introduce myself and to explained that I really liked is project and I contributed with a pull request.
He answered me just one day after that He is gonna look at this and thanked me for my interest.
2-days without any response, I sent a new mail to say that there is no problem if I have to make any change to my PR.
Magically, My PR was accepted(The same day) and He merged that to the main project, it was my first contribution to an Open Source Project on GitHub.
## Journal
It wasn't easy at all to find an Open-source project to which I can contribute easily for a first contribution.
When I found an interesting project named Bokeh (https://github.com/bokeh/bokeh), an Open-Source project which provides a library for vizualition of plots with Python scripts, pretty much similar to Matlplotlib, Plotly, I was happy.
But my unexperience made that I've done some communication mistakes as explained earlier and I didn't had any response after more than 3 weeks of trying contributing.
I think my biggest mistake was to thing that because I know how to code and I'm in last year of Master Degree in UCLouvain I had some legimity to show my coding skills and my knowledge. But It was pretty straightforward that people don't care from who you are or what's your formation.
They just want peoples who have a real interest for the project, and which respect the rules of the communication in the project(which shows the real interest for the project) and I haven't made that with Bokeh, but It was a learning and I'm sure that It will be useful to me in the next of my carrier because I know what I must not do.
My final idea was to add a feature to PythonBrokenEnglish. The process was described in sections above.
## Conclusion
Contributing to an Open-Source project was a great experience. I learned a lot of things, really. I think that this first contribution to an Open-Source project provides me with some experience with the real world of projects. For me It was a real pleasure when the PR was accepted and merged because It was so difficult the experience that I had with Bokeh that It shows me that by taking my time and by doing thinks in the right way, I can do it. So thank you.
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter