openedx / openedx/openedx-platform

Make course_overviews independent of LMS

Open
#37,658 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.2k
Forks
4.4k
Avg merge
6d 18h
Merged PRs (30d)
42

Description

course_overviews imports from lms in several places, which goes against the rule that shared code (xmodule, common, openedx) should not depend on service-specific code (cms, lms).

Practically speaking, this causes lint-imports to fail a lot on unrelated PRs, and means we need to add a bunch of exceptions to the importlinter config in setup.cfg.

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 locating the course_overviews imports from lms and review the dependency rule for shared code such as xmodule, common, and openedx. Check setup.cfg and run lint-imports to identify the current violations. Done means course_overviews no longer depends on lms and the unrelated import-linter failures and exceptions are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.