What is Git: https://www.atlassian.com/git/tutorials/what-is-git
STEPS:
- Download from: https://git-scm.com/download/win
- Click next through installer, leave all default options on.
Clone the BuildUP repository either directly from github or using the Github Desktop Client.
When it comes to code contributions, we generally follow the Gitflow workflow model: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow.
When contributing to this package, your work should always be done in a new branch. We use feature branches.
What are feature branches: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow
Each new feature should always reside in its own branch. When a feature is complete, it gets merged back into the master branch.
When your work is done, submit your pull request and once it has been approved, you can merge your branch.
Follow this pattern exactly so that searching is easier:
<prefix>/<summary>
| Prefix | Use Case |
|---|---|
| feature | New feature addition |
| defect | Bug or defect fix |
| wip | Works in progress |
| junk | Throwaway branch created to experiment |
Example branch name:
feature/rewards-page