openedx / openedx/sample-plugin

Separate init step for migrations shouldn't be necessary

Open Beginner friendly
#46 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
4
Avg merge
3d 1h
Merged PRs (30d)
8

Description

The code here introduces separate tutor ... do init steps for running Django migrations for the sample plugin. This shouldn't be necessary since the plugin is installed with the rest of the Django dependencies which get picked up and migrated automatically.

Not critical, but maybe confusing, and definitely slows init down by 30+ seconds to spin up the container and run the whole no-op migration path.

https://github.com/openedx/sample-plugin/blob/ccc9a1d8fd0df178fb6bed24ff42259587b98afa/tutor-contrib-sample/tutorsample/plugin.py#L41-L52

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 tutor-contrib-sample/tutorsample/plugin.py at lines 41–52 and inspect how the sample plugin is included in the normal Django migration flow. Remove the separate migration init steps if they are redundant, then verify that the sample plugin migrations are picked up during the standard initialization without the extra 30+ seconds.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.