Development Guidelines

Requirements for PR reviews to merge faster the existing and new pull requests:

• If the pull request is a small bug fix with tests, then only one (1) core developer review is necessary.
• If the pull request is a feature or significant change then at least two (2) core developers should review.
• If the pull request is from core developers only another (1) core developer review is required unless that reviewer suggests more reviewers.
• If the pull request is a small bug fix with tests, then this core developer (author of this fix) can merge this without any reviews.
• In the case of conflicts voting is going to be performed.
• More PR reviewers without commit rights should be added!
• Each release is going to have one release manager to manage which PRs should be included.

How to prepare pull request for merging to main branch by doing "squash" or "rebase" on it:

https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request

To install the current codebase locally run

pip install .

To install in editable mode

pip install -e .

This means that import clr will pick up the version from the development directory.

To run clr tests:

python -m pytest