Contributing to Open Source Software: Difference between revisions
(Add page for contributing to open source sofware) |
(Make heading levels, level 2) |
||
| Line 1: | Line 1: | ||
=Introduction= | ==Introduction== | ||
This page aims to document the general process for contributing to open source software on the Web. | This page aims to document the general process for contributing to open source software on the Web. | ||
| Line 6: | Line 6: | ||
Therefore, this page will focus on GitHub. | Therefore, this page will focus on GitHub. | ||
=Pre-Requisites= | ==Pre-Requisites== | ||
GitHub hosts open-source software repositories using the version control system (VCS) '''git'''. | GitHub hosts open-source software repositories using the version control system (VCS) '''git'''. | ||
| Line 12: | Line 12: | ||
https://git-scm.com/ | https://git-scm.com/ | ||
=Contribution Process= | ==Contribution Process== | ||
The process is generally the same for contributing to any GitHub repository. | The process is generally the same for contributing to any GitHub repository. | ||
Revision as of 22:41, 11 June 2020
Introduction
This page aims to document the general process for contributing to open source software on the Web.
There are different platforms for hosting open-source software projects, with GitHub being one of the most popular.
Therefore, this page will focus on GitHub.
Pre-Requisites
GitHub hosts open-source software repositories using the version control system (VCS) git.
Therefore, you need to install git on your machine if you don't already have it: https://git-scm.com/
Contribution Process
The process is generally the same for contributing to any GitHub repository.
Typically, when you don't have write permissions for the repository, you need to perform the following steps:
1. Fork the repository 2. Clone your fork 3. Perform, and test your changes locally (preferably on a dedicated branch) 4. Push your changes to your remote fork 5. Submit a Pull Request to the "upstream" repository
The following article outlines this process in further detail: https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/