Skip to content

Commit

Permalink
add Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Colin Kennedy committed Sep 23, 2022
1 parent aff5388 commit 109dc14
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Speedrun-statechannels repository has an unusual configuration because the end product is intentionally broken: ie, it has specific gaps in implementation that are meant to be filled in by students doing the tutorial.

Making improvements to this implementation-with-holes is... not fun. So the intent here is to maintain side-by-side branches:

- `main`: the student-facing default branch with implementation gaps
- `completed`: a branch with the gaps filled in

Work to improve the end-result application should be done against the `completed` branch, merged into the completed branch, and then cherry-picked back to `main`.

0 comments on commit 109dc14

Please sign in to comment.