openedx / openedx/docs.openedx.org
Edit/update Dev Guide > Code Quality section
Open
Nobody has claimed this yet.
developers
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
- Review/edit for accuracy https://docs.openedx.org/en/latest/developers/references/legacy_guide/testing/code-quality.html - addressed by https://github.com/openedx/docs.openedx.org/pull/432
- Move to the "Writing Good Code" section (currently section 7)
Contributor guide
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 with the linked Code Quality page and inspect the current “Writing Good Code” section, identified as section 7. Move the Code Quality material into that section and verify the documentation navigation and rendered page. Done means the content appears under the intended section without leaving an unwanted duplicate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100