oppia / oppia/oppia-web-developer-docs
Create Tutorial - Learn to Determine How a Feature Works (End-to- End)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
Notes from Sean: This is a full-stack code tracing tutorial, can use some content from https://github.com/oppia/oppia/wiki/Find-the-right-code-to-change. Called “Trace code through all the frontend and backend layers to understand and describe how a feature works across these layers” in skill trees.
Try to pick an example that’s not necessarily 100% clear right off the bat, e.g. as exemplified in “Tips for analyzing the codebase” (https://github.com/oppia/oppia/wiki/Analyzing-the-Codebase).
Run a git patch file to repro https://github.com/oppia/oppia/pull/17988
Reasoning: The solution changes are minimal here but debugging it is a bit tricky and it could be a good starting point to figure out repro steps from error logs.
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
Review the linked “Find the right code to change” and “Analyzing the Codebase” wiki guidance, then use a git patch to reproduce Oppia pull request #17988 and inspect the resulting error logs. Done means publishing a tutorial that traces one feature through its frontend and backend layers and explains how to determine how it works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- documentation, full-stack
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100