-
Notifications
You must be signed in to change notification settings - Fork 71
Contributing Code
Radhakrishna Sanka edited this page Jul 29, 2020
·
2 revisions
Please refer to CONTRIBUTION.md first before reading the rest of this guide.
| Name | Explanation |
|---|---|
master |
This branch is the release branch of the repository, only merge changes into this branch when a new release is set to come out |
dev |
This is the default development branch that contains stable development code and features which are slated for a release |
gh-pages |
This is the branch that is used for deploying 3DuF on github pages |
| Name | Explanation |
|---|---|
bug-<issue #> |
This branch would address the specific issue described on the corresponding issue |
feature-<issue #>-<Description Text name> |
This branch would involve the development of the feature described in the issue |
All contribution branches need to be created based on the dev branch, contributors should ensure that they have the latest version of the dev branch before they start creating a new branch based on dev. So in practice, the user would need to fork the repository and perform the following steps after making a local clone of the fork.
- Switch to the dev branch -
git checkout dev - Create a new branch based on the latest
dev-git checkout -b <new branch name>