Skip to content

Latest commit

 

History

History
139 lines (87 loc) · 4.27 KB

CONTRIBUTING.rst

File metadata and controls

139 lines (87 loc) · 4.27 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

Report bugs at https://github.com/mabuchilab/QNET/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs / Implement Features

Look through the GitHub issues for bugs or feature requests. Anybody is welcome to submit a pull request for open issues.

Write Documentation

QNET could always use more documentation, whether as part of the official QNET docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/mabuchilab/QNET/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Follow Aaron Meurer's Git Workflow Notes (with mabuchilab/QNET instead of sympy/sympy)

In short,

  1. Clone the repository from [email protected]:mabuchilab/QNET.git
  2. Fork the repo on GitHub to your personal account.
  3. Add your fork as a remote.
  4. Pull in the latest changes from the develop branch.
  5. Create a topic branch
  6. Make your changes and commit them (testing locally)
  7. Push changes to the topic branch on your remote
  8. Make a pull request against the base develop branch through the Github website of your fork.

The project contains a Makefile to help with development tasts. In your checked-out clone, do

$ make help

to see the available make targets.

It is strongly recommended that you use the conda package manager. The Makefile relies on conda to create local testing and documentation building environements (make test and make docs).

Alternatively, you may use make develop-test and make develop-docs to run the tests or generate the documentation within your active Python environment. You will have to ensure that all the necessary dependencies are installed. Also, you will not be able to test the package against all supported Python versions. You still can (and should) look at https://travis-ci.org/mabuchilab/QNET/ to check that your commits pass all tests.

Branching Model

QNET uses the git-flow branching model. That is, the develop branch takes the role of master in the Git Workflow Notes.

In order to create topic branches with git flow, after cloning the qnet repository, you should initialize it as follows:

$ git checkout master
$ git flow init
$ git checkout develop

Testing

QDYN's uses pytest for testing. The test-suite for all supported Python versions is run with

$ make test

This creates a conda environment for each supported Python version in ./.venv, installs the QDYN package and all prerequisites into that environment, and runs py.test.

In order run a specific test, you may invoke py.test manually with the appropriate options, e.g.

$ ./.venv/py36/bin/py.test -s -x ./tests/algebra/test_abstract_algebra.py

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. Check https://travis-ci.org/mabuchilab/QNET/pull_requests and make sure that the tests pass for all supported Python versions.