Follow-up: Bible for Managers

[kavuong]

Objectives

To integrate everyone's feedback on the Bible for Reviewers.

Follow-up work should be done directly on the managers-bible branch/variant.

• Everyone provides initial feedback review of everyone's work on pull request Managers bible #73

  • Set-up of overall pull request to master

• Organize meeting on Saturday to discuss entire Bible

• Follow-up work done on the following: (from Bible for Reviewers #29)

• Receiving module assignments documentation

  • Based on "Pre-approval" and "Post-approval" Checklists
  • Sections (or info that should be covered)
    • Pre-approval: What To Do
    • Explanation of Role of Epics + Assigning Epic Points
      • Module epic points = activity epic points + lab epic points + workshop epic points
    • Explanation of Role of Issues (curriculum issues)
      • issues should be made constantly
    • Explanation of Role of Milestones
    • Adding Issues to Epics (Modules + Activities + Labs)
      • point of discussion: should there be epic points on curriculum issues?
    • Long-term Plan with examples
    • Zenhub Calendar

• Weekly Manager's Tasks documentation (directions on what manager should complete every week)

  • Based on "Weekly Manager Checklist"
  • Sections (or what info should be provided)
    • Fri/Sun/Tues Timeline + "first draft" explanation + "final draft" explanation
    • Explanation of issues to be set-up each week (long-term plan) and first-timer issues
      • emphasis that issues have to fully address the long-term plan
    • Setting up Milestones
    • Adjusting long-term plan and epic points for each activity + lab epic based on activity last week + feedback

• Role of GitHub Projects

• Weekly Code Review Documentation (directions on reviewing devs' pull requests)

  • Based on "First Draft Pull Request Checklist"
    • Explanation of each part - why is each part important?
    • point of discussion: project labels and what should the naming and overall format of this PR be?

• Weekly Pull Request Documentation (directions on sending pull requests to master)

  • Complete "Final Draft Checklist"
    • Each part to be documented - why is each part important?
  • point of discussion: is a final draft pull request even necessary?

• Documentation on Specific QA procedures for managers and developers (

  • Goal: Complete projects as swiftly as possible while incorporating developers' and managers' input into and throughout the entirety of the project.
  • Preliminary idea
    • Managers and I (Kevin) must conduct code reviews on GitHub
      • Checking issues and contributions
        • In every pull request, there needs to be a list of checkboxes addressed
        • Managers: Need to make sure all assigned issues in milestone were completed and that checkbox contributions match the assigned issues
      • Every PR must have comments that address checkboxes
        • Every checkbox needs to be addressed with a comment
          • Comments can be positive or constructive

• Documentation on Specific QA for Kevin and Daniel

• Kevin will audit a random PR from dev to manager to ensure comments are being left.
• Overall similar to code reviews
  • Kevin: Need to make sure that all assigned issues and checkbox contributions are connected with the long-term plan
  • Daniel: checking after Kevin
  • Daniel's Code Review
  • Daniel will audit a random one of Kevin's code reviews, Kevin will audit a random one of each manager's code reviews

• Role of Writing Team (Victoria Xu right now)
  • Essentially when all curriculum is merged to master after Kevin and Daniel's QA there needs to be a procedure for proofreading

Collaborators and Tasks
@kavuong - initial review of everyone's work, organize meeting
All collaborators from #29:

• @ismaildude - Module Assignments Documentation (first task)
• @ojgao - Weekly Manager Checklist and GitHub projects (second and third tasks)
• @mxthu313 - Weekly Code Review Documentation (fourth task)
• @JasonL24 - Documentation on Specific QA procedures for managers and developers (fifth task)
• @jeffchhen - Documentation on Specific QA procedures for Kevin and Daniel (sixth task)

Deadline
Thursday, 4/2 initial review by everyone
Follow-up work by Friday, 4/3

Final Review by @kavuong Wed, 4/8