openedx / openedx/openedx-core
New App Checklist
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 32
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 12
Description
Need to write a doc of things so we don't forget. Should mention
- import linter
- model conventions
- private API conventions
- public API conventions
- preferred way to make tests
- places where we deviate from OEP-49 (particularly how we pass around querysets)
- philosophy on small apps that encapsulate discrete pieces of functionality
- philosophy on extensible models
- boundaries we want to enforce (e.g. leaving authorization out)
(other folks please feel free to add stuff)
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
The issue names no target file or existing documentation entry point. Start by reviewing the listed conventions and OEP-49, then identify where the new app checklist belongs; done means a documented checklist covering the requested conventions, testing guidance, architectural boundaries, and queryset deviations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100