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 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 Gitlab issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the Gitlab issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

allen1989 could always use more documentation, whether as part of the official allen1989 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 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 allen1989 for local development.

Fork the allen1989 repo on gitlab.com.

Clone your fork locally:

$ git clone git@gitlab.com:your_name_here/allen1989.git

Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development:
```
$ virtualenv dvlpt
$ dvlpt/script/activate
(dvlpt)$ pip install -e .
```
Create a branch for local development (wip stands for work in progress):
```
(dvlpt)$ git checkout -b wip_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:
```
(dvlpt)$ cd allen1989
(dvlpt) allen1989$ flake8
(dvlpt) allen1989$ pytest

(dvlpt) allen1989$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to Gitlab:

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

Submit a merge request through the Gitlab 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 39.

Tips¶

To run a subset of tests:

$ pytest test/test_XXX