Skip to content

Commit

Permalink
refactor: Add refresh from upstream/master to "Making a Change" ins…
Browse files Browse the repository at this point in the history
…tructions.

Add instructions to explicitly refresh from `upstream/master` as the first step in the "Making a Change" instructions in the "How to Contribute" section. This will ensure that before any new changes are started a copy of the PMRoK Wiki content will be merged into the working branch.

Resolves: pmrok-chgmgt issue #21 suggestion #2
See also: #21
  • Loading branch information
jdmedlock committed Feb 16, 2018
1 parent 438f081 commit fad7544
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions Home-Contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,23 @@ If you have previously cloned the "mirror" repo you should *_always_* refresh it


### Making a Change
1. Create a new _working branch_ with a descriptive name. For example, `fix/softskill-url`.
Any changes or additions to make should be made to this working branch. Remember to issue frequent commits if you are making multiple changes so there is a detailed trail of each change you've made.
2. When you are ready to share with others or if you just need to ensure that your in progress work
1. Create a new working branch with a descriptive name. For example, `fix/softskill-url`. Any changes or additions to make should be made to this working branch.
2. Refresh the repo with the latest version of upstream/master as described above.
3. Make your changes. Remember to issue frequent commits if you are making multiple changes so there is a detailed trail of each change you've made.
4. When you are ready to share with others or if you just need to ensure that your in progress work
is backed up push your changes to the `pmrok-chgmt` repo using the same working branch name. For example, `git push origin fix/softskill-url`.
3. If you should need to refresh your working branch from GitHub simply
5. If you should need to refresh your working branch from GitHub simply
`git pull origin <working-branch>`.
4. When your changes are completed you can start the process of promoting them to the wiki by
6. When your changes are completed you can start the process of promoting them to the wiki by
creating a PR to merge your changes into the `development` branch. Be sure to select `PMCAB` as
the reviewer and once changes have been reviewed and approved you will be responsible for
performing the merge.
5. Once your change has been merged into the `development` branch it will be ready to merge into
7. Once your change has been merged into the `development` branch it will be ready to merge into
the `master` branch along with changes submitted by others. A member of the _PMRoK Change Approval
Board (PMCAB)_ will periodically create a PR to promote all changes from `development` to `master`.
6. Merging into `master` by a member of the PMCAB will automatically start the TravisCI integration
8. Merging into `master` by a member of the PMCAB will automatically start the TravisCI integration
script to move changes to the PMRoK Wiki.
7. Once the TravisCI integration script has completed the approved changes will be available to
9. Once the TravisCI integration script has completed the approved changes will be available to
all users of the PMRoK Wiki.

If you are curious about the _Change Approval Board_ process it is a concept that's part of the
Expand Down

0 comments on commit fad7544

Please sign in to comment.