If you wish to contribute to the repository, have in mind that we follow some git flow standards.
Say you want to start working on a new feature. First, make sure you are at the develop branch.
git checkout develop
Next you cant start a new feature using git flow as such:
git flow feature start meaningful_description
This will:
- Create a new
feature/meaningful_descriptionbranch - Switch you into it
From there, you can work in your desired feature.
When you're done (don't forget to add and commit all the desired changes) you can send your branch to the origin.
Important: Before submitting your PR, make sure your branch is up to date
with develop. It is best practice to perform a rebase before sending
your branch upstream. This can be done in the following manner.
git checkout develop
git pull
git checkout feature/meaningful_description
git rebase develop
When your feature is ready, simply:
git push origin feature/meaningful_description
Now head over to GitHub and send your Pull Request.
Important: Make sure you send the PR to develop and not master!
Feel free to tag anyone from the group. Your work needs the revision
of at least one member for it to be merged into the develop branch.
Once your PR is accepted you can
git flow feature finish meaningful_description
This will:
- Merge your feature branch to develop locally
- Delete this feature branch
- Leave you at the
developbranch