Fold this repo into XBlock

Open
#419 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
build-system

Research direction

Start by comparing this repository with the XBlock repository and inspect repo-tools/setup.py, especially its EXTRAS_REQUIRE handling. Define how this repository can live in an isolated subdirectory with its own requirements file and be exposed through xblock[sdk] without pulling SDK development tools into xblock[django]. Done means the repositories are merged and both extras install the intended dependencies.

Written by the indexing model from the issue text.

Description

code health

This repository is useful to XBlock developers, and it is tightly coupled to XBlock. So, let's merge it into the XBlock repository.

Considerations:

  • It should be isolated to a sub-directory and have its own requirements file. The requirements file should be available via extras-require. This way, edx-platform can run pip install xblock[django] (so that it doesn't pull in sdk dev tool packages) and developers can run pip install xblock[sdk].
Dominant language
JavaScript
Stars
69
Forks
104
Avg merge
22h 11m
Merged PRs (30d)
9

Getting set up

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.

More from openedx/xblock-sdk

All issues in openedx/xblock-sdk

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.