Skip to content

Commit 689af52

Browse files
committed
Document the user workflow
Problem: Access to this repo must be available to any user on github. Solution: Describe in README the acceptable workflow using the 'fork' option in the github UI. Signed-off-by: eccles <phewlett76@gmail.com>
1 parent cd36c38 commit 689af52

3 files changed

Lines changed: 277 additions & 123 deletions

File tree

BUILDING.md

Lines changed: 0 additions & 119 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ If you're addressing a bug, please explain how to reproduce it.
1414
## Pull request and git commit guidance
1515

1616
### Opening PRs and organizing commits
17+
18+
See the documented workflow described in the README.md file detailing the sequence of
19+
git commands required to submit a PR from a fork of this repo.
20+
1721
PRs should generally address only 1 issue at a time. If you need to fix two bugs, open two separate PRs.
1822
This will keep the scope of your pull requests smaller and allow them to be reviewed and merged more quickly.
1923

@@ -70,11 +74,12 @@ Generally, pull requests need two approvals from maintainers to be merged.
7074

7175
When addressing review feedback, it is helpful to the reviewer if additional changes are made in new commits.
7276
This allows the reviewer to easily see the delta between what they previously reviewed and the changes you added
73-
to address their feedback.
77+
to address their feedback. These commits should be in the form of 'fixups' ('git commit --fixup HEAD').
7478

7579
Once a PR has the necessary approvals, it can be merged.
80+
7681
Here’s how the merge should be handled:
77-
- All PR's should use the “Squash and merge” option.
82+
- Once approved the author will be asked to squash all fixup commits generated by the review process.
7883
- Commits and their messages should be consistent - each commit in the PR should form a logical unit with working code.
7984
- The first change requested by a Jitsuin reviewer will be to reorganise the commits into a clean logical structure.
8085
- The smaller a PR the more likely and more easily that the change will be approved.

0 commit comments

Comments
 (0)