-
Notifications
You must be signed in to change notification settings - Fork 4
Guide to Reviewing Pull Requests
Here are things to consider when reviewing Pull Requests to Ada Curriculum:
-
We value curriculum that is as clear to everyone as it can be, so if something in a Pull Request isn't totally clear to you, please call that out! Your experience reading the curriculum is incredibly valuable - it should shape the curriculum!
-
We use this style guide to inform the way we write curriculum. Make sure to read it before reviewing so we are all aligned.
-
We prefer PRs to go through as few rounds of back-and-forth as possible while still giving all feedback that is helpful. This means reviewing the PR thoroughly the first time you review it and if you notice something new on the 2nd or 3rd time reviewing the same PR, double-check whether its necessary feedback. In other words, weigh the importance of that input against the fatigue that the feedback will probably create for the poster of the PR.
-
We prefer PR feedback to be exclusively about things that were changed in the PR. If there is a sentence or paragraph or example that wasn’t changed in the PR, even if it’s in the same section, refrain from commenting in the PR you’re reading and consider creating your own PR to make that change. This avoids PR bloat.
Ada Core Repos (Blocks):
- About Ada
- Unit 1
- Unit 2
- Unit 3
- Lightning Talks
- Projects
- Problem-Solving Exercises (PSEs)
Contributing to Curriculum:
Teaching and Learning at Ada:
Curriculum Review Committee: