Table of contents
Your first contribution
To contribute new functionality to OpenProblems, please follow the steps below:
- Search through the GitHub Issues tracker of the task to ensure that no one else is already working on the feature you would like to add.
- If someone is already working on it, post in that issue to express your interest or reach out to the contributors working on the issue directly.
- If there is no existing issue tracking the feature, create a new one.
-
Review the key concepts of OpenProblems to get a good grasp of the framework as a whole.
-
Install the necessary requirements to work with OpenProblems.
-
Follow the getting started guide to fork and clone the repository and download the necessary test resources.
-
Add a method, metric, or control method to the framework.
-
Run the provided unit tests to ensure that the new functionality passes.
-
Create a pull request from your branch to the OpenProblems main branch. Don't forget to add an entry to the CHANGELOG.md file describing the proposed changes.