oppia / oppia/oppia-web-developer-docs
Create Tutorial - How to do a code review.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
Notes from draft wiki doc per Sean’s comment: Should cover: Review code for quality, correctness, and security; leave clear review comments
You could create a draft PR with some errors for them to review? Even if it's closed, they could still do their own draft review and then compare their answers with a worked example.
Open a draft PR for tutorial 1 (Implementing new feature) – This will involve both backend and frontend changes.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the draft wiki notes and the existing Tutorial 1, “Implementing new feature.” Create a code-review tutorial covering quality, correctness, security, and clear review comments, then prepare the requested draft PR for Tutorial 1 with backend and frontend changes. Done means the tutorial includes the draft-review exercise and a worked example or comparison path.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100