How to contribute to an Open Source Project
Erwan ROUSSEL Oct 21
This is October, so many people want to contribute to an Open Source Project, especially with the #hacktoberfest challenge. But when you start, it's difficult to understand how to do it. That's why I decided to write this post.
Do you want to contribute to an open source project? Here's how!
1st - Read the README
If you already did it, you are lucky, if not, READ IT! It is called
2st - Feature, fix ?
If you have a feature idea, just create an issue to describe the feature and don't forget to say that you can code it!
If not, take a look at the issues, maybe you can fix something.
3rd - Read the CONTRIBUTING file
All the things you have to do are written in the CONTRIBUTING file. Read it carefully. You have chosen your project! You are very happy and you want to contribute!
4th - Fork the project and code!
You just have to click on the little button at the right corner of the repository page. Example :
You'll need to learn how to use Git -> Git Learning Guide
Then clone your project.
Add your modifications.
5th - Commit and create your Pull Request (PR)
- Now, you have to commit your modifications.
Then, click on the Pull request button on the official repository page :
New Pull Request and then click on
Create pull request
Give your pull request a title and a comment (According to the CONTRIBUTING file)
And finally, click on
Create Pull Request.
You made your first Pull Request !!!
I hope it will help you ^
Thanx to Quantum Sheep