Git and GitHub workflow#
The preferred workflow for contributing to aeon’s repository is to fork the main repository on GitHub, clone, and develop on a new branch.
Fork the project repository by clicking on the ‘Fork’ button near the top right of the page. This creates a copy of the code under your GitHub user account. For more details on how to fork a repository see this guide.
Clone your fork of the aeon repo from your GitHub account to your local disk:
git clone firstname.lastname@example.org:<username>/aeon.git cd aeon
<username>is your GitHub username.
Configure and link the remote for your fork to the upstream repository:
git remote -v git remote add upstream https://github.com/aeon-toolkit/aeon.git
Verify the new upstream repository you’ve specified for your fork:
git remote -v > origin https://github.com/<username>/aeon.git (fetch) > origin https://github.com/<username>/aeon.git (push) > upstream https://github.com/aeon-toolkit/aeon.git (fetch) > upstream https://github.com/aeon-toolkit/aeon.git (push)
mainbranch of your fork with the upstream repository:
git fetch upstream git checkout main git merge upstream/main
Create a new
featurebranch from the
mainbranch to hold your changes:
git checkout main git checkout -b <feature-branch>
Always use a
featurebranch. It’s good practice to never work on the
mainbranch! Name the
featurebranch after your contribution.
Develop your contribution on your feature branch. Add changed files using
git addand then
git commitfiles to record your changes in Git:
git add <modified_files> git commit
When finished, push the changes to your GitHub account with:
git push --set-upstream origin my-feature-branch
Follow these instructions to create a pull request from your fork. If your work is still work in progress, open a draft pull request.
We recommend to open a pull request early, so that other contributors become aware of your work and can give you feedback early on.
To add more changes, simply repeat steps 7 - 8. Pull requests are updated automatically if you push new changes to the same branch.