Skip to content

Latest commit

 

History

History
25 lines (10 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

25 lines (10 loc) · 1.55 KB

Contributing to Cytoscape.js

Cytoscape.js is an open source project, and anyone interested is encouraged to contribute to Cytoscape.js. To contribute, fork Cytoscape.js, commit your changes, and send a pull request.

Where to put changes

New features go in the unstable branch, which is used for the next (breaking/major or feature/minor) version. Bugfixes go in the master branch for the next bugfix/patch version. This allows us to follow semver nicely.

The source is organised in relatively the same as the documentation, under ./src. Try to maintain that organisation as best you can. You are free to create new files and require() them using the CommonJS/Node.js style.

Code style

Use two spaces for indentation, and single-quoted strings are preferred. The main thing is to try to keep your code neat and similarly formatted as the rest of the code. There isn't a strict styleguide.

Testing

Tests go in the ./test directory, as Mocha tests usually do. They are just a flat list of .js files that Mocha runs. If your change is a bugfix, please add a unit test that would fail without your fix. If your change is a new feature, please add unit tests accordingly. If your change is visual/rendering-related, then unit tests are not possible.

Please run gulp test to make sure all the unit tests are passing before you make your pull request.