Every open source project lives from the generous help by contributors that sacrifice their time and moodlepy is no different. To make participation as pleasant as possible, this project adheres to the Code of Conduct by contributor-covenant.
-
Fork the moodlepy repository to your GitHub account.
-
Clone your forked repository of moodlepy to your computer:
$ git clone https://github.com/<your username>/moodlepy
$ cd moodlepy- Add a track to the original repository:
$ git remote add upstream https://github.com/moodlepy/moodlepy- Install dependencies with poetry:
$ pip install poetry
$ poetry install --no-root- Install pre-commit hooks:
$ pre-commit installRecommended linter (linting) mypy and code formater yapf.
If you already know what you'd like to work on, you can skip this section.
If you have an idea for something to do, first check if it's already been filed on the issue tracker. If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue and assign yourself to it.
Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster.
That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from the maintainer.
Currently we are using moodle sandbox as webdocumentation source.
Log in to moodle sandbox with username admin password sandbox.
- Open Site admiistration > Plugins > Web Services > Overview
- Enable web services. Check the checkbox and Save changes.
Open Site admiistration > Plugins > Web Services > API Documentation (API Documentation)