Curriculum Review Standards¶
ALL contributions to the NRE Labs curriculum must be done via a Pull Request, and Pull Requests
can only be merged to
master if the latest commit on that Pull Request’s branch satisfies all of
- Passes all Github CI checks
- Has a valid “accepted” review from a curriculum committer that is different from the PR creator.
These are meant to be done in order. There is no point in conducting a review until all Github CI checks pass. However, once these are passing, the next step is for a reviewer to approve or make suggestions for a second round of edits for your content. Note that the goal for each and every review is not to nitpick or make it difficult to contribute to NRE Labs, but rather to ensure the content is reflected in the best light possible. Be patient and willing to adapt to feedback.
Here are a few things that reviewers should be on the lookout for when reviewing new contributions to the curriculum, either for new or existing lessons. If you’re contributing to the curriculum, you should be aware of these guidelines, to make the review process much smoother.
(Hopefully) Automated Checks¶
The following should be automatically checked via the CI tooling, but please double-check, and if the CI tooling missed any of the below, please open an issue on the curriculum repo.
- Is the CHANGELOG updated properly?
Quality is important in NRE Labs. Here are some general things to be on the lookout for.
- Is the relevance to the learner clear from this lesson? How easy is it for people to link this content with their day-to-day?
- Does each lesson stage hit the target length of 5-10 minutes?
- Are the lesson guides easy to follow? Are they well-written, with appropriate chunking, puncuation/grammar, and visuals?
It’s also very important that the curriculum takes maximum advantage of the underlying Antidote platform.
- Does this follow the Lesson Image Requirements?
- Does the lesson appropriately take advantage of Antidote’s optional features for content depth, like optional objective verification or diverse presentations? How about lesson diagrams or videos?
- Do the configuration mechanisms in place for the Endpoints properly reverse/forward based on stage?