-
Notifications
You must be signed in to change notification settings - Fork 2
Managers bible #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Managers bible #73
Changes from 1 commit
06d129b
c9600db
d5b9767
50f5838
c613fa3
3ee3061
e169a23
214130d
8d4f4fb
5cb18d6
135ff22
903da58
8d4d520
403c7c7
6216077
395500b
512b2cb
371d0c0
a5b1dc1
1a662e1
0f3a875
033ed4b
986b9ec
6709a3e
95a721b
586a8cc
62fbf18
d4ad57e
5289f96
601492e
923290d
842b0bc
b505171
daf643f
b64ea60
c1d4e70
b41eeb9
8b9b12e
1e139c5
fe3927e
a81745d
ef9f0bd
620293e
85100c9
cd339c1
c2ec1b3
994bf7e
1106e37
5b54e6b
aaf3906
7136df5
9165f8d
9c0cde6
4e60451
757f86a
b1cb690
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| # Guide to Being a Manager | ||
|
|
||
| **Italics indicate sections that still should be reviewed.** | ||
|
|
||
| Reviewers are in charge of **curriculum teams.** Each team consists of 4-6 people who work on different modules of curriculum. They will be tasked with a project, usually covering a topic, and a deadline. By this deadline, all activities, labs and workshops for that project should be completed. | ||
|
|
||
| ## Starting Off: Receiving Module Assignments | ||
|
|
@@ -36,6 +38,8 @@ This checklist will be posted within the issue and should all be completed withi | |
| * [ ] Make sure activity titles and descriptions written and formatted properly | ||
| * [ ] Make sure lab titles and descriptions written and formatted properly | ||
|
|
||
| ## _Module Assignments Documentation \[Ismail\]_ | ||
|
|
||
| ### Role of Epics + Assigning Epic Points | ||
|
|
||
| Epics represent long-term \(in the form of GitHub issues\) that will keep you on track to finish weekly assignment,activities & labs, and entire modules. These epics should be assigned points not based on how long they will take to complete but the overall, implementation based difficulty. Activity,Lab ,and workshop epics are assigned different points and they add up to represent the total weight/points of an entire module. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @ismaildude I have provided comments on your entire section here: Role of Epics + Assigning Epic PointsShould be emphasized that epics are just GitHub issues and that Epics give hierarchical structure to GitHub issues which let us keep track of project progress within GitHub.
Explanation of Role of Issues
Explain of Role of Milestones
Adding Issues
ZenHub
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. that is an awkward place to put an aside/reflexive clause
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "weekly assignments" – p sure it's supposed to be plural
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. just write out and in place of the ampersand
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "...but on the overall..."
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the spacing after your commas are incorrect in some places
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. so is your capitalization. and i would not mention "weight" the first time in the last sentence without any prior preface. Also you make it seem as if weights and points are interchangeable. are they? @kavuong are they tho?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mxthu313 Weights do not exist anymore, just points |
||
|
|
@@ -90,6 +94,36 @@ You should use ZenHub as a visual deadline guide and reminder. You will create E | |
| * [ ] Weekly Team Sync | ||
| * [ ] 1:1s with devs | ||
|
|
||
| ## _Weekly Manager Checklist Documentation \[Owen\]_ | ||
|
|
||
| ### Deadlines: | ||
|
|
||
| Friday: Friday deadlines are the fist draft deadlines for your team. This means that your team members should have finished their issues and submitted a pull request to your branch for review. You should take the next few days to work on any problems that come up after review. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There should be an explanation of the developer and manager branch process.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also "next few days" is just Saturday (to give developers ample time to implement changes)
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @kavuong do devs request a review from their reviewers? or assign it to them?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Devs should request a review from managers |
||
|
|
||
| Sunday: Sunday deadlines are the final draft deadlines for you team. This means that you should submit a pull request to master with your team's completed work for the week. There will also be a form that documents your team's work for the week that is due. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There should be a mention for both Friday and Sunday that PRs should follow the given pull request template in GitHub, with an example of the text and a screenshot of a completed pull request before making it.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. -can you make it explicit that you have to merge the dev's branches into the reviewer's?
|
||
|
|
||
| Tuesday: Tuesday deadlines are for the issues that need to assigned to your team. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The issues should be raised by Monday, under our new remote paradigm.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ### Issues: | ||
|
|
||
| Issues are unresolved problems that developers need to address. As a manager, it is your job to raise issues for your developers and assign them each week. You should make sure that there are enough issues each week to be worked on, raising issues as you review your developer's work as well as in line for your long-term goals. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i think a better intro would be that reviewers need to raise 2 types of issues each week. the majority for their devs, and a minority for new comers (mention that this is for onboarding purposes <-- transparency) |
||
|
|
||
| There are also other issues that should be raised and given as first-timer issues. These issues are generally less complicated resource wise compared to other issues. This does not mean that they are less difficult content wise. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. there should be examples of first-timer issues. |
||
|
|
||
| All issues addressed should fully address the long-term plans set up! | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "address" is suboptimal word choice imo. feel free to ignore me |
||
|
|
||
| ### Milestones: | ||
|
|
||
| Milestones are used to organize your weekly team's weekly tasks. Issues are placed into your milestones to keep track of your team's work for the week. To create a milestone go to the issues tab in GitHub and there should be a milestones button to the left of the new issue button. Here you can create new milestones as assign tasks to your milestones. In addition your milestones should follow the naming convention of your team-week of- Tuesday of week. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The day should be Monday. Also there should be a screenshot of a milestone, as well as how to add an issue to a milestone.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you introduce some syntactical/formatting difference between names of tabs and buttons and normal text? that would help greatly |
||
|
|
||
| ### Adjustments: | ||
|
|
||
| After all your weekly tasks are completed, assess your long-term plan and make any changes necessary. If a part of your activity is completed, assign the appropriate epic points. If there was not as much progress as originally thought, modify the long-term deadlines. Adjust overall long-term plan according to the week's progress and any feedback from developers. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have no idea what this means: "If a part of your activity is completed, assign the appropriate epic points."
|
||
|
|
||
| ### Github Projects: | ||
|
|
||
| Github Projects are another source of organization for your long-term plans. You can use them to group issues of your long-term plan for a module and track the progress of completion. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There should be a description on how a manager should keep the kanban board updated (to do/blocked/in progress/done columns) You can look at my project board for reference: https://github.com/orgs/bitprj/projects/4 All of the issues that a manager is responsible for ultimately doing (short-term and long-term) as well as their status should be kept track in here
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you're going to really have to specify how these differ from epics, cause i have no clue |
||
|
|
||
| ## Pull Request Checklist | ||
|
|
||
| Every week, there are a couple essential things that every manager should take care in pull requests. This checklist applies to both pull requests from developers' branches to managers' branches and from managers' branches to `master`. | ||
|
|
@@ -117,6 +151,43 @@ Every week, there are a couple essential things that every manager should take c | |
|
|
||
| This checklist should be pasted into each review, and checked off completely by Sunday. | ||
|
|
||
| ## _Weekly Code Review Documentation \[Michelle\]_ | ||
|
|
||
| Performing code reviews is an incredibly important step, and this function has to be done for every pull request for each of the developers every week. To start you dev should have requested a review from you. If not, please gently remind them or just request yourself. Then you should see a geen "leave a review" button and pressing that will lead you to a page displaying the code differences. You should leave comments on the code that you are viewing with specific things that they can improve on in their nect iteration. | ||
|
|
||
| These specific changes should all contribute one way or another to the "Pull Request Checklist" as shown above. This checklist has to be pasted into each pull request. When reviewing, it is important to focus on both the "macro" and the "micro" issues that need to be resolved. This check list helps reviewers raise issues and review in a more efficient manner. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. there needs to be much more about the checklist itself, and why each item is important for the manager to check (generally all of those issues are fundamental to curriculum and always apply week to week.) |
||
|
|
||
| Stemming from an effort to be more transparent and let developers be aware of how their work contributes to the organization as a whole, this list both ensures proper workflow and a more stylistically workflow. As more and more of the list is checked off, the developer is able to see their progress. Ideally, the list for a specific PR is completely checked off by the end of the week. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Mention that this checklist applies to ALL pull requests
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ## _Quality Assurance Procedures for Managers and Developers \[Jason\]_ | ||
|
|
||
| We want to the developers and the managers to provide give their input for each aspect of our projects. Therefore, we need procedures that allow the developers to quickly and effectively work together to complete tasks while maintaining a standard of quality. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ### Procedure: | ||
|
|
||
| * [ ] Managers and Kevin conduct code reviews through GitHub | ||
| * [ ] Checking Issues and contributions | ||
| * Each time a developer makes a Pull Request, they need to provide a list of check boxes of items they addressed for their work that week. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these checkboxes are from the overall development checklist |
||
| * When managers review each Pull Request, they must check to ensure that all assigned issues in the milestone were completed and the checkbox contributions match the assigned issues. | ||
| * [ ] Every checkbox must be addressed with a comment by the reviewer | ||
| * A comment can acknowledge that the developer did something correctly or give constructive feedback. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. examples of positive/constructive comments should be given here
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. as well as an entire code review on a couple paragraphs of curriculum, also supplemented with checkboxes addressed |
||
|
|
||
| ## _Revision by Head of Developer Relations and President \[Jeff\]_ | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. grammar throughout the section is shaky
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. generally don't mention our specific names, mention titles with our names being in parentheses the first time and no other time.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you be consistent as to whether you use "Bit" or "Bit Project"? Also I can totally imagine a white lady in a pant suit walking slowly and gesturing with her sightly wrinkled middle aged hands in the foreground of who knows where because it may as well be a stock photo of some generic nature or car dealership. |
||
|
|
||
| Here at Bit, we place heavy emphasis that all content and material developed by Bit is up to our standards. In addition to material being reviewed by respective managers, the material will undergo further review by the head of Develop Relations, Kevin Vvuong, as well as the President of Bit Project, Daniel Kim. We have many developer teams at Bit and this process is necessary to ensure all material is synchronous and consistent. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| Kevin will occasionally audit a random Pull request from a developer to a manager and ensure proper feedback is being provided. While Kevin is auditing, he will be looking to ensure the content matches Bit Project's long term goals and is consistent with the other material. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not occasionally, every week. Also I am checking for the pull request template being followed, all items from the "Pull Request Checklist" being followed, and that positive/constructive comments on all checkboxes are being given. this needs to be more specific |
||
|
|
||
| Daneil, as president, will also audit Kevin's pull requests to ensure quality is consistent through all curriculum by Bit Project. It will conducted in a similiar process to Code Reviews performed by managers. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we shouldn't say Kevin or Daniel, since we will be replaced eventually. Say President and Head of Developer Relations |
||
|
|
||
| In order for curriculum to have a level of quality expected of Bit Project, we have implemented 3 checks. | ||
|
|
||
| 1. Approval by Manager | ||
|
|
||
| 2. Approval by Kevin Vvoung | ||
|
|
||
| 3. Approval by Daniel Kim | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel like there should be a section just about maintaining good communication with your team members (through slack?) and the importance of keeping track of everyone's progress throughout the week |
||
| ## General Development Review Checklist | ||
|
|
||
| The following checklist must be fully completed before an Epic deadline, and also serve as a general guide to development. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,5 +2,3 @@ | |
|
|
||
| Here are the roles within the People Team: | ||
|
|
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,12 +2,6 @@ | |
|
|
||
| ## Description | ||
|
|
||
| * **Responsibilities** | ||
| * **Requirements** | ||
| * | ||
| ## Responsibilities | ||
|
|
||
| * | ||
| ## Requirements | ||
|
|
||
| * | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,12 +2,6 @@ | |
|
|
||
| ## Description | ||
|
|
||
| * **Responsibilities** | ||
| * **Requirements** | ||
| * | ||
| ## Responsibilities | ||
|
|
||
| * | ||
| ## Requirements | ||
|
|
||
| * | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are "managers" and "reviewers" being used interchangeably or should we stick to one for consistency?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"managers" should be used