Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.1 KB

Contributing

Please open issues to discuss enhancements and bugs that you may encounter with pyNeuroML. Pull requests with enhancements and bug fixes are welcome.

Code style

  1. We use flake8 to ensure that the code follows a consistent style as part of continuous integration on Travis. Currently, the information from flake8 is informative only.

  2. The source code uses spaces, and each tab is equivalent to 4 spaces.

  3. We use the reStructuredText (reST) format for Python docstrings. Please document your code when opening pull requests.

Pull Request Process

  1. Please contribute pull requests against the development branch.
  2. Please ensure that the automated build for your pull request passes.
  3. Please pay attention to the results from flake8 and make any modifications to ensure a consistent code style.

Pre-commit

A number of pre-commit hooks are used to improve code-quality. Please run the following code to set up the pre-commit hooks:

$ pre-commit install