openedx-filters-samples

Overview

Used to create Open edX Filters steps for testing purposes.

Open edX Filters Steps

Filter steps
ModifyUsernameBeforeRegistration
ModifyUserProfileBeforeLogin
ModifyModeBeforeEnrollment
ModifyContextBeforeRender
StopEnrollment
StopRegister
StopLogin
StopUnenrollment
StopCertificateCreation
StopCourseAboutRendering
StopCourseHomeRendering
StopDashboardRender
StopCertificateRender
StopCohortChange

Development Workflow

One Time Setup

# Clone the repository
git clone git@github.com:edx/openedx-filters-samples.git
cd openedx-filters-samples

virtualenv -p python3.8 openedx-filters-samples

Every time you develop something in this repo

# Activate the virtualenv
source venv/bin/activate

# Grab the latest code
git checkout main
git pull

# Install/update the dev requirements
make requirements

# Run the tests and quality checks (to verify the status before you make any changes)
make validate

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.
vim …

# Run your new tests
pytest ./path/to/new/tests

# Run all the tests and quality checks
make validate

# Commit all your changes
git commit …
git push

# Open a PR and ask for review.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.