Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 3.33 KB
Raw

Contributing

Contributions of all kinds are welcome. In particular, pull requests (PRs) are appreciated. The maintainers of this repository will help walk you through any issues in the pull request discussion, so please feel free to open a pull request even if you are new to pull requests.

Issues

The easiest contribution to make is to file an issue. Please perform a search of existing issues and provide clear instructions for how to reproduce a problem. If you have resolved an issue yourself, please contribute it to this repository so others can benefit from your work.

Please note that we cannot, in general, answer questions about particular connectivity measures and their merits. The user should be responsible for understanding the statistics they are using. Canonical papers for each connectivity measure are listed in the docstring of each connectivity measure. Questions and issues regarding implementation of the connectivity measures are welcome.

Code

Code contributions are always welcome, from simple bug fixes to new features. To contribute code:

  1. Please fork the project into your own repository and make changes there. Follow the Developer Installation instructions in the README to set up an environment with all the necessary software packages.
  2. Run black and flake8 on your code.
  3. Add tests for bugs/new features and make sure existing tests pass. Tests will run through github actions.
  4. Add docstrings for each function in the numpy style.
  5. Add references if you are adding a connectivity measure.
  6. Submit a pull request.

If you are fixing a known issue, please add the issue number to the PR message.

If you are fixing a new issue, file an issue and then reference it in the PR.

How to build the documenation

  1. Change directory to spectral_connectivity/docs
  2. Run make html to preview the docs.
  3. A commit to the master branch will automatically build the docs on readthedocs.

How to make a release

  1. Bump the version number and tag the commit
  2. Upload to pypi
git clean -xfd
python setup.py sdist bdist_wheel
twine upload dist/*
  1. Upload to conda. This requires anaconda and conda-build.
CONDA_DIR=~/miniconda3
USER=edeno

conda skeleton pypi spectral_connectivity --noarch-python --python-version 3.6

conda build spectral_connectivity --no-anaconda-upload --python 3.6

anaconda upload $CONDA_DIR/conda-bld/*/spectral_connectivity-*.tar.bz2 -u $USER --skip

rm -r spectral_connectivity
conda build purge-all
  1. Release on github.

Authorship on manuscripts

Authorship on any manuscripts for the spectral_connectivity package will be granted based on substantive contributions to the design and implementation of the spectral_connectivity package. This is not soley determined by lines of code or number of commits contributed to the project, but these will be considered when making this decision. For example, a one letter correction in documentation will not be considered substantive for authorship (although typo correction is very much appreciated).