Thanks for reaching this document. Contributions are very welcomed!
-
Creating a PR:
- Bug fixes
- Increasing test coverage
- Typos
- Addressing an existing issue
- Optimizations
-
Creating an issue:
- New features
- Refactors
- New tools
- Changes to GitHub Actions
By clicking on Fork in the top right, below your account icon.
You can now clone your fork locally and start to work on you changes:
git clone [email protected]:<USERNAME>/sogol.git
Create a new branch to work on. It will be more convenient to create more PRs if your master branch has not "drifted" from upstream's (to not overwrite history).
In any case, make sure to rebase from upstream (this repo) before creating a new branch and before creating a PR to upstream.
git pull upstream master
git checkout -b my_branch
# Working on changes
# ...
# Rebasing from upstream
git pull --rebase upstream master
git push origin my_branch
Now that your work is pushed to origin (your fork), you can create a PR to upstream.
Thank you for participating!