diff --git a/README.rst b/README.rst index bfd8cb45..7b1a2b82 100644 --- a/README.rst +++ b/README.rst @@ -15,60 +15,14 @@ This repository implements the necessary tooling and definitions used by the Hooks Extension Framework to manage the filters execution and extra tools. -Getting Started -*************** -Developing -========== +Getting Started with Development +******************************** -One Time Setup --------------- -.. code-block:: - - # Clone the repository - git clone git@github.com:openedx/openedx-filters.git - cd openedx-filters - - # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it - mkvirtualenv -p python3.8 openedx-filters - -Every time you develop something in this repo ---------------------------------------------- -.. code-block:: - - # Activate the virtualenv - workon openedx-filters - - # 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 / - - # 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. +Please see the Open edX documentation for `guidance on Python development `_ in this repo. Deploying -========= +********* The Open edX Filters component is a Python library which doesn't need independent deployment. Therefore, its setup is reasonably @@ -86,7 +40,7 @@ Getting Help Documentation ============= -See the `Open edX Hooks Extension Framework guide `_ in edx-platform. +See `documentation on Read the Docs `_. More Help =========