In this article we will see the importance of Github (version tool) for Open-Source contribution and the best practices to be followed while creating or contributing to Open-Source.
GitHub hosts your source code projects in a variety of different programming languages and keeps track of the various changes made to every iteration.
It is all about the collaborative effort of the community, in reviewing, improving, and deriving new ideas from the uploaded code. It’s definitely something worth looking into!
Some importance features that make Github one of the best and a go to tool.
- Easy to use and best for open source contribution.
- Everything is available in spot from documentation, code, issues, updates etc.
- Easy to share and showcase your contribution.
- Track share and merge available at single point.
- Increased Safety with packages.
- Easy Code hosting.
Since we know the importance of Github now let’s see what guidelines to follow while contributing to Open Source.
- First create an account on Github
- Get your Github basic right before diving deep in creating pulling request, forking, or creating your commits.
- Start creating repositories of the preferred language of your choice.
- Always ensure when you create the repository the README.md document is available.
- Before you start contributing to open-source make sure you read the contributing document available in the README file or CONTRIBUTING file of the project. Understand your role and then start contributing.
- Check if there is any licensing attached to the project.
- We do have wiki sections/ tab available for most of the projects, please go through the important details which is required towards contribution.
8. Also there is a Security section/Tab if the project as some security guidelines to be followed related Reporting a Vulnerability.
9. Make sure when you commit the code to open-source you use proper naming convention for the commit message if there one in the contributing guidelines.
10. If you are a first-time contributor, please ensure you recheck your commit, tags, descriptions, tests passing and all the relevant details are available.
11. Avoid duplicate issues, please go through the closed issues to avoid duplicates.
So, I recommend you go out and explore various projects on GitHub and start contributing and become a part of Open-Source Community.
If you would like to share your first-time experience in contributing to Open-Source, then leave your comment below.