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/SnowEx/snowexsql/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¶

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

Adding Jupyter Notebooks¶

This project can always use examples of using the data from the database. To add an example simply:

Create a new jupyter notebook under docs/gallery. Name the notebook <your_project>_example.ipynb. Note it must have the _example to be found by sphinx (documentation software).
Add a brief goal of the notebook and an enumerate steps list. Then use markdown ### e.g. ### Step 1: to demarcate each step so it shows up in the table of contents
After you have created/ran it, tag a cell with figures to make use of thumbnails in the docs. Those are:
- nbsphinx-thumbnail
- nbsphinx-gallery

Note: you can assign these tags pretty easy by accident to other blocks simultaneously which will break the thumbnail generator. If your thumbnail doesn’t show up then check which blocks had tags enabled

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/SnowEx/snowexsql/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? Here’s how to set up snowexsql for local development.

Fork the snowexsql repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/snowexsql.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 snowexsql
$ cd snowexsql/
$ python setup.py develop
```
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 flake8 and the tests, including testing other Python versions with tox:
```
$ pytest
```
To get flake8 and tox, just pip install them into your virtualenv.

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.

3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check .. https://travis-ci.com/SnowEx/snowexsql/pull_requests

and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ pytest tests.test_snowexsql

Deploying¶

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

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.