├── .gitignore ├── README.md └── img ├── THE-DANGER-ZONE.png ├── contribution-count.png ├── contribution-graph-heat-map.png ├── copy-new-repo-URL.png ├── create-new-repository.png ├── enter-the-project-name.png ├── local-git-repo-pushed-to-new-GH-repo.png ├── rename.png ├── scroll-down-to-the-bottom.png ├── select-New-repository.png ├── select-the-project-Settings-tab.png └── update-contribution-count.png /.gitignore: -------------------------------------------------------------------------------- 1 | # macOS system resource file 2 | .DS_Store 3 | 4 | # NodeJS modules 5 | node_modules 6 | 7 | # VIM resource files 8 | *.sw[a-p] 9 | 10 | # VSC resource files 11 | .vs 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Lambda School Code Review Checklist 2 | 3 | Code review is the time to catch issues and help students who don't understand concepts from the day or week. A thorough code review may take between 90-120 minutes, but you can do a condensed code review in under 30 minutes. Instructors, PMs, or peer mentors can use the code review as an opportunity to push and challenge students technically. While students should feel free to ask questions, they should also be ready to explain and defend your code. 4 | 5 | ## Part I - Review Projects 6 | 7 | Review each project, including assignments, personal projects, or Sprint Challenges since the last code review. At a minimum, review the code for the following: 8 | 9 | 1. Each project is pushed to GitHub with clear, detailed commit messages. 10 | 2. Each project is feature complete and works as expected. 11 | 3. There are no exceptions or warnings in your console or Chrome Developer Tools. 12 | 4. Code follows consistent naming conventions, language idioms, and style. 13 | 5. Code is written by the student. 14 | 15 | ## Part II - Review Objectives 16 | 17 | Objectives from the Training Kit are written in our 'Student can...' format, and reflect the skills the student will have demonstrated in their project, assignment, or sprint challenge. Using the student's tracker, review each competency or objective in each sample of code, and determine a rating (0-3) on each one. 18 | 19 | Ask to see examples of each objective in the project. Ask the student to explain the code and how it demonstrates their mastery. 20 | 21 | #### Rating Scale 22 | 23 | | Score | Description | 24 | | :-- | :-- | 25 | | 0 | Not observable | 26 | | 1 | Does not understand, does not meet expectations | 27 | | 2 * | Understands with assistance, meets expectations | 28 | | 3 | Understands independently, exceeds expectations | 29 | 30 | * `2` is the default score. A `3` should only be awarded when the student has demonstrably mastered the objective. 31 | 32 | ##### NOTE: Ratings are not grades, and there are no GPAs. Students and reviewers should come to a consensus rating to understand where the student excels, and where the student may need some extra attention or help. 33 | 34 | ## Part III - Review Past Objectives 35 | 36 | Choose a handful of previous objectives to review or discuss. If the code review is happening in a peer mentoring setting, this will likely happen with one student reviewing another's code. 37 | 38 | Focus on objectives where the student did not meet expectations. If the student has reviewed and improved, update the score. Otherwise, address the concerns in this step, or when making a plan. 39 | 40 | ## Part IV - Make a Plan 41 | 42 | Make a plan. Focus on fixing deficiencies first, then focus on mastery, stretch goals, or other advanced work. 43 | 44 | Plans should include videos, resources, or exercises the student will complete in order to improve their mastery. 45 | 46 | ## Part V - Address Any Additional Needs 47 | 48 | If there are any specific needs or concerns with the student, share them with a PM or Instructor. 49 | 50 | ## Part VI - Student Pull Request Feedback Template 51 | 52 | ```markdown 53 | ## Great 54 | 55 | ## Requested Improvements 56 | 57 | ## Questions 58 | 59 | ## Rating: {1-3} 60 | 61 | #### GitHub Contribution Graph 62 | ``` 63 | 64 | ## Part VII - GitHub Contribution Graph 65 | 66 | ![Heat Map](img/contribution-graph-heat-map.png) 67 | 68 | ### UPDATE 69 | 70 | We recommend against de-forking while in class - just so all the links submitted stay active. But, you don't really need to de-fork anything. 71 | 72 | All the commit history lives in the `.git` folder in the local Git repo directory - you just need to get the project up to GitHub. This can be as simple as: 73 | 74 | 1. creating a new repo on GitHub, 75 | 2. giving it a unique name to help distinguish it in your GitHub repository list, and 76 | 3. pushing the project up to the new GitHub repository. 77 | 78 | It might help to make a "Team" to keep the "active student" repositories separate from the ones pushed up for the heatmap. 79 | 80 | Lambda School's 2019 [Git branching workflow](https://youtu.be/cSoHP7WSsEg) will result in contributions reflected in your GitHub heatmap. 81 | 82 | Latest update: 2/8/2019 83 | 84 | *** 85 | 86 |
The following is deprecated

87 | 88 | Unfortunately, commits made in a fork are not counted towards the contribution graph on your GitHub profile. Please see the "[Commit was made in a fork](https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile/#commit-was-made-in-a-fork)" section of GitHub's _"Why are my contributions not showing up on my profile?"_ article: 89 | > Commits made in a fork will not count toward your contributions. To make them count, you must do one of the following: 90 | > 91 | > 1. Open a pull request to have your changes merged into the parent repository. 92 | > 2. To detach the fork and turn it into a standalone repository on GitHub, contact [GitHub Support](https://github.com/contact). If the fork has forks of its own, let support know if the forks should move with your repository into a new network or remain in the current network. For more information, see "[About forks](https://help.github.com/articles/about-forks/)." 93 | 94 | Option one is not available to Lambda School students. With option two, you should find that GitHub Support is very friendly and timely with their response. You can, however, get your "Heat Map" to accurately reflect your contributions another way. Please visit [this repository](https://github.com/LambdaSchool/GitHub-Contribution-Graph). You will find detailed instructions on how to "de-fork" your repositories. :octocat: 95 | 96 |

97 | -------------------------------------------------------------------------------- /img/THE-DANGER-ZONE.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/THE-DANGER-ZONE.png -------------------------------------------------------------------------------- /img/contribution-count.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/contribution-count.png -------------------------------------------------------------------------------- /img/contribution-graph-heat-map.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/contribution-graph-heat-map.png -------------------------------------------------------------------------------- /img/copy-new-repo-URL.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/copy-new-repo-URL.png -------------------------------------------------------------------------------- /img/create-new-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/create-new-repository.png -------------------------------------------------------------------------------- /img/enter-the-project-name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/enter-the-project-name.png -------------------------------------------------------------------------------- /img/local-git-repo-pushed-to-new-GH-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/local-git-repo-pushed-to-new-GH-repo.png -------------------------------------------------------------------------------- /img/rename.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/rename.png -------------------------------------------------------------------------------- /img/scroll-down-to-the-bottom.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/scroll-down-to-the-bottom.png -------------------------------------------------------------------------------- /img/select-New-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/select-New-repository.png -------------------------------------------------------------------------------- /img/select-the-project-Settings-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/select-the-project-Settings-tab.png -------------------------------------------------------------------------------- /img/update-contribution-count.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bloominstituteoftechnology/Code-Review-Checklist/745b309f8e08bb4b136c4f52da93c48c686b8ad6/img/update-contribution-count.png --------------------------------------------------------------------------------