openedx / openedx/docs.openedx.org

Dev Guide > Django best practices section

Open
#408 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

developers
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

https://docs.openedx.org/en/latest/developers/references/legacy_guide/conventions/django.html

  • Add a second best practice, or link out to a collection of best practices
  • Add a Django REST framework practice

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 with the linked Django best-practices page in the legacy developer guide. Add either a second Django best practice or a link to a best-practices collection, and add one practice for Django REST framework. Done means both checklist items are addressed in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
django
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.