Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

99 lines (69 loc) · 3.17 KB
Raw

Contributing to cvxsimulator

This document is a guide to contributing to cvxsimulator

We welcome all contributions. You don't need to be an expert (in optimization) to help out.

Checklist

Contributions are made through pull requests. Before sending a pull request, make sure you do the following:

  • Run 'make fmt' to make sure your code adheres to our coding style. This step also includes our license on top of your new files.
  • Write unit tests
  • Run the unit tests and check that they're passing

Building cvxsimulator from source

You'll need to build cvxsimulator locally in order to start editing code. To install cvxsimulator from source, clone the Github repository, navigate to its root, and run the following command:

make install

We assume you have poetry installed.

Contributing code

To contribute to cvxsimulator, send us pull requests. For those new to contributing, check out Github's guide.

Once you've made your pull request, a member of the cvxsimulator development team will assign themselves to review it. You might have a few back-and-forths with your reviewer before it is accepted, which is completely normal. Your pull request will trigger continuous integration tests for many different Python versions and different platforms. If these tests start failing, please fix your code and send another commit, which will re-trigger the tests.

If you'd like to add a new feature to cvxsimulator, please do propose your change on a GitHub issue, to make sure that your priorities align with ours.

If you'd like to contribute code but don't know where to start, try one of the following:

  • Read the cvxsimulator source and enhance the documentation, or address TODOs
  • Browse the issue tracker, and look for the issues tagged "help wanted".

License

A license is added to new files automatically as a pre-commit hook.

Code style

We use black and ruff to enforce our Python coding style. Before sending us a pull request, navigate to the project root and run

make fmt

to make sure that your changes abide by our style conventions. Please fix any errors that are reported before sending the pull request.

Writing unit tests

Most code changes will require new unit tests. Even bug fixes require unit tests, since the presence of bugs usually indicates insufficient tests. cvxsimulator tests live in the directory tests, which contains many files, each of which contains many unit tests. When adding tests, try to find a file in which your tests should belong; if you're testing a new feature, you might want to create a new test file.

We use the popular Python pytest framework for our tests.

Running unit tests

We use pytest to run our unit tests. To run all unit tests run the following command:

make test

We keep a close eye on our coverage via

make coverage

Please make sure that your change doesn't cause any of the unit tests to fail.