monmouth-college-cs / sddc-reading-notes-monmouth-college-comp-335

sddc-reading-notes-monmouth-college-comp-335 created by GitHub Classroom
0 stars 0 forks source link

Workflow for Notes #20

Open jlmayfield opened 5 years ago

jlmayfield commented 5 years ago

@monmouth-college-cs/monmouth-college-comp-335 I'm going to require a particular branch management/project workflow for at least the next set of notes because it seems there is a lack of self-organizing happening.

  1. Everyone prepares their individual contributions in a brand-new, clean branch. Only your notes should be in that branch when you push it. Nothing else. For recording/grading purposes keep, I want these branches left untouched. Do not delete them when the note set is done.
  2. Whomever is running point for the current note set should create a well-named working branch. All individual contributions are to be submitted as PR to this branch. PRs must be reviewed by at least one other person.
  3. Once notes are combined, a PR should be made to the master branch. This should be reviewed by everyone.
  4. Everyone, not just @davidhsonic , should known how to add the latest notes to the github pages part of the repository. I'm like that direction and want the end results of this effort to be a website.
  5. Each new note set should have a milestone associated with it. Issues and PRs for the note set should be added to that milestone and closed when appropriate.
  6. I expect deadlines and progress beyond and before my imposed deadlines.
davidhsonic commented 5 years ago

@jlmayfield Would the PR to master go through, or be cancelled after the review? Because I can't see a reason to put the individual notes into master.

jlmayfield commented 5 years ago

@davidhsonic The PR to master is only for the final product. By "notes are combined" I mean compiled into the HTML document for the web. You're right, the individual notes shouldn't be in the pull request.