Contributing to Open Source Software: Difference between revisions
(Make heading levels, level 2) |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
There are different platforms for hosting open-source software projects, with GitHub being one of the most popular. | 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. | Therefore, this page will focus on [https://github.com/ 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'''. | ||
1. First, you need to install '''git''' on your machine. Either of the below links are good references: | |||
https://git-scm.com/ | |||
* https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | |||
* https://www.atlassian.com/git/tutorials/install-git | |||
2. Next, create an account on [https://github.com/ GitHub]. | |||
==Contribution Process== | ==Contribution Process== | ||
| Line 18: | Line 22: | ||
1. Fork the repository | 1. Fork the repository | ||
2. Clone your fork | 2. Clone your fork | ||
3. Perform, and test your changes locally (preferably on a dedicated branch) | 3. Perform, and test your changes locally (preferably on a dedicated branch) | ||
4. Push your changes to your remote fork | 4. Push your changes to your remote fork | ||
5. Submit a Pull Request to the "upstream" repository | |||
5. Submit a [https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests Pull Request] to the "upstream" repository | |||
The following article outlines this process in further detail: | The following article outlines this process in further detail: | ||
https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ | https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ | ||
[[Category:GitHub]] | |||
Latest revision as of 01:42, 1 August 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.
1. First, you need to install git on your machine. Either of the below links are good references:
- https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- https://www.atlassian.com/git/tutorials/install-git
2. Next, create an account on GitHub.
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/