Skip to main content

Contributing

This page explains how to contribute to OpenCircuits.

Setup​

Installing​

See installation

Building​

See building

Running​

See running

Unit Tests​

See testing

Submitting your code​

Make sure your code passes all linting without any errors or warning. Code with an error or warning will not be merged.

Before submitting – always make sure to build and run unit tests (we won't merge any request that fails Travis CI)

Pushing directly to the master branch is prohibited so if you make changes put it on a new branch and make a pull request to have your changes merged into master after being reviewed.

Old Code​

If you're working on part of the refactor, it can be very helpful to reference some of the old code.

Here is a link to the old directory.