Contributing¶

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

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/cloudbopper/synmod/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¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

synmod could always use more documentation, whether as part of the official synmod 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/cloudbopper/synmod/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.

Get Started!¶

Ready to contribute? Here’s how to set up synmod for local development.

Fork the synmod repo on GitHub.

Clone your fork locally:

git clone git@github.com:your_name_here/synmod.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
mkvirtualenv -p python3 synmod
cd synmod/
pip install -r requirements_dev.txt -r requirements.txt
```
Create a branch for local development:
```
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the pylint/flake8 and the tests for all python versions:
```
tox
```
You may use pyenv to install and test with multiple python versions.

While testing with a specific python version, you may invoke the tests as follows:
```
pytest tests
```

Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

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

The pull request should include tests.
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.
The pull request should work for Python 3.5, 3.6, 3.7 and 3.8. Check https://travis-ci.com/cloudbopper/synmod/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

pytest tests/test_synmod.py  # Only run tests from specific file
pytest -k test_simulation_interactions tests/test_synmod.py  # Only run specific test from given file

To run debugger within pytest:

pytest --trace  # Drop to PDB at the start of a test
pytest --pdb  # Drop to PDB on failures

To generate interactive coverage report:

make coverage

To profile the code:

make profile

To run linters:

make lint

Deploying¶

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in CHANGELOG.rst). Then run:

bumpversion patch # possible: major / minor / patch
git push
git push --tags

Travis will then deploy to PyPI if tests pass.