forked from arras-energy/gridlabd-old
-
Notifications
You must be signed in to change notification settings - Fork 1
Workflow for use case feature development
Anna Peery edited this page Apr 26, 2021
·
1 revision
The following workflow is an example for an ICA use-case.
- Create branch for a feature from the head use_case branch. This only needs to be done once per feature.
Command | Result |
---|---|
git checkout use_case/integration_capacity |
Switches to ICA branch |
git pull origin use_case/integration_capacity |
Updates ICA branch |
git checkout -b use_case/integration_capacity_feature_name use_case/integration_capacity |
Creates a feature branch off of the ICA branch |
- Before beginning work, make sure that your branch and your files are up to date. This should be done every time you work on the feature.
Command | Result |
---|---|
git pull origin use_case/integration_capacity |
Updates ICA branch |
git pull origin use_case/integration_capacity_feature_name |
Updates feature branch |
git checkout use_case/integration_capacity_feature_name |
Switches to feature branch |
git merge use_case/integration_capacity use_case/integration_capacity_feature_name |
Updates changes from head branch into feature branch |
- Commit changes and push. This should be done every time you make changes to the script.
Command | Result |
---|---|
git commit -m “message” |
Commits changes with a note |
git push origin use_case/integration_capacity_feature_name |
Pushes changed file to the feature branch |
-
Stage a draft pull request on GitHub. Make sure it’s staged for use_case/integration_capacity, not for master or develop. This should be done at the first commit to the feature branch.
-
Once finished with feature implementation, mark pull request as “Ready for review” and tag reviewers. This should be done only when a feature is completed, functional and ready for review by the team.
-
Reviewers will review the PR in the GitHub UI for code differences and commits that were made.
-
Reviewers will run tests in feature branch to verify that feature is working locally.
-
Once compatibility and functionality of new feature is confirmed, reviewer will use GitHub UI to “Squash and Merge” the PR.