openedx / openedx/openedx-platform
docs: Document import linting
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
We added import linting to the edx-platform code base but there are no docs on it in the edx-platform testing docs.
We should update those docs to include a section on import linting.
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 edx-platform testing documentation at docs.openedx.org/projects/edx-platform/en/latest/concepts/testing/testing.html. Read the surrounding testing guidance and add a section explaining import linting. Done means the testing docs contain clear import-linting guidance in the requested location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100