Contributing to Open Source Projects
Fri, Oct 21, 2022
One-minute read
Projects with my contributions
- API Dev Tools: JSON Schema $Ref Parser
GitHub Flow
Fork the repository
On the GitHub repository, use the page UI to fork the repository.
Clone the repository
git clone https://github.com/<my-username>/<forked-repository>.git
Configure a Remote for the fork
git remote add upstream https://github.com/<original-owner-username>/<forked-repository>.git
Check the result with:
git remote -v
Sync the fork
git fetch upstream
git checkout main
git merge upstream/main
Adding New Features for a PR
Feature branch
git push --set-upstream origin <feature-branch>
Make a PR
Once the <feature-branch>
is completed, go to the original forked repository and create a “New Pull Request” - specify the forked repository and the feature branch. Add notes to enrich the PR to increase the acceptance, and go along with required changes by the maintainer(s) of the project.