openedx / openedx/openedx-proposals

Update Technology Recommendations and Related Decisions

Open
#531 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feb25 help wanted
Dominant language
Python
Stars
50
Forks
47
Avg merge
1d 14h
Merged PRs (30d)
2

Description

OEP-67 recommendations that need to be reviewed and potentially updated.

Updates to existing recommendations
  • Codecov is generally recommended not just recommended for the frontend, add a new overall ADR to reflect this general recommendation.
Historic Standards that need notes and ADRs
  • Django
  • DRF
  • drf-yasg
  • tox
  • pytest
  • edx-lint
Related: Frontend changes

#524
#480

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading OEP-67 PR 518, then review related issues #524 and #480. Work through the checklist for Codecov, Django, DRF, drf-yasg, tox, pytest, and edx-lint; done means the recommendations are reviewed and the requested notes or ADRs are added or updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.