Support and Development¶
This project is open-source. Users are highly encouraged to contribute directly by implementing new features and fixing issues. Development for packages as part of the signac framework should follow the general development guidelines outlined here.
A brief summary of contributing guidelines are outlined in the CONTRIBUTING.md file as part of the repository. All contributors must agree to the Contributor Agreement before their pull request can be merged.
Set up a development environment¶
Start by forking the project.
We highly recommend to setup a dedicated development environment, for example with venv:
~ $ python -m venv ~/envs/signac-dev ~ $ source ~/envs/signac-dev/bin/activate (signac-dev) ~ $ pip install pre-commit
or alternatively with conda:
~ $ conda create -n signac-dev -c conda-forge python=3 pre-commit ~ $ conda activate signac-dev
Then clone your fork and install the package from source with:
(signac-dev) ~ $ cd path/to/my/fork/of/signac (signac-dev) signac $ pip install -e .
-e option stands for editable, which means that the package is directly loaded from the source code repository.
That means any changes made to the source code are immediately reflected upon reloading the Python interpreter.
The pre-commit tool is used to enforce code style guidelines. To install the tool and configure pre-commit hooks, execute:
(signac-dev) signac $ pip install pre-commit (signac-dev) signac $ pre-commit install
With the pre-commit hook, your code will be checked for syntax and style before you make a commit. The continuous integration pipeline for the package will perform these checks as well, so running these tests before committing / pushing will prevent the pipeline from failing due to style-related issues.
The development workflow¶
Prior to working on a patch, it is advisable to create an issue that describes the problem or proposed feature. This means that the code maintainers and other users get a chance to provide some input on the scope and possible limitations of the proposed changes, as well as advise on the actual implementation.
All code changes should be developed within a dedicated git branch and must all be related to each other. Unrelated changes, such as minor fixes to unrelated bugs encountered during implementation, spelling errors, and similar typographical mistakes must be developed within a separate branch.
Branches should be named after the following pattern:
Choose from one of the following prefixes depending on the type of change:
fix/: Any changes that fix the code and documentation.
feature/: Any changes that introduce a new feature.
release/: Reserved for release branches.
If your change does not seem to fall into any of the above mentioned categories, use
Once you are content with your changes, push the new branch to your forked repository and create a pull request into the main repository. Feel free to push a branch before completion to get input from the maintainers and other users, but make sure to add a comment that clarifies that the branch is not ready for merge yet.
Prior to fixing an issue, implement unit tests that fail for the described problem. New features must be tested with unit and integration tests. To run tests, execute:
(signac-dev) signac $ python -m pytest tests/
Benchmarks can be run using the asv (airspeed velocity) tool. To install the tool, execute:
(signac-dev) signac $ pip install asv
asv tool will install signac into an isolated virtual environment that is used for benchmarking.
Below is a quick reference with some helpful commands:
$ asv run master..mybranchbenchmarks every commit from
$ asv publishgenerates a static HTML site showing benchmark results.
$ asv previewhosts a local preview of the generated HTML site.
$ asv devruns benchmarks that are in development.
$ asv profile 'benchmarks.ProjectBench.time_iterate_load_sp(.*)' --gui=snakevizwill profile a specific test and visualize results with snakeviz.
For more information on how to use asv, refer to Using airspeed velocity.
Building documentation requires the sphinx package which you will need to install into your development environment.
(signac-dev) signac $ pip install Sphinx sphinx_rtd_theme
Then you can build the documentation from within the
doc/ directory as part of the source code repository:
(signac-dev) signac $ cd doc/ (signac-dev) doc $ make html
Updating the changelog¶
To update the changelog, add a one-line description to the changelog.txt file within the
next ---- - Fix issue with launching rockets to the moon. [0.6.3] -- 2018-08-22 --------------------- - Fix issue related to dynamic data spaces, ...
Just add the
next section in case it doesn’t exist yet.