Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Updates ORG in The process of writing chapters
  • Loading branch information
acocac authored Oct 6, 2023
1 parent 70cca05 commit 692cf31
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,12 @@ GitHub has a [nice introduction][github-flow] to the pull request workflow, but
- Edit the chapter for style.
- Once the first draft of the chapter is complete change [WIP] in the pull request title to [Ready for review].
- Add a comment on the pull request indicating that this chapter is ready for high-level review, i.e discussion of changes of the scale of a paragraph or larger such as adding material and restructuring sections.
- Discuss and make these high-level changes on this pull request. Once this is complete merge the chapter into The Alan Turing Intitute's version of the chapter branch.
- Make another pull request from your fork's version of the branch to The Alan Turing Institute's version of the branch. Title this "[Ready for review] Chapter_name chapter- low-level reviews".
- Discuss and make these high-level changes on this pull request. Once this is complete merge the chapter into The _The Turing Way_'s version of the chapter branch.
- Make another pull request from your fork's version of the branch to _The Turing Way_'s version of the branch. Title this "[Ready for review] Chapter_name chapter- low-level reviews".
- Discuss and make low-level changes to the chapter on this pull request, such as rewording sentences, typos and the like.
- This division of the pull requests into high and low-level changes stops discussion threads from becoming unmanageable.
- Once this is complete merge the pull request into The Alan Turing Intitute's version of the chapter branch.
- Merge The Alan Turing Intitute's version of the chapter branch into The Alan Turing Institute's main branch.
- Once this is complete merge the pull request into _The Turing Way_'s version of the chapter branch.
- Merge _The Turing Way_'s version of the chapter branch into _The Turing Way_'s main branch.
- DO not delete the branch as the chapter may continue to undergo improvement and development in the future.

## Local development
Expand Down

0 comments on commit 692cf31

Please sign in to comment.