# Contributing

Thank you for helping twtxt to get a better piece of software.

## Support

If you have any questions regarding the usage of twtxt please visit us in the #twtxt IRC channel on FreeNode
or post your question on [StackOverflow](https://stackoverflow.com).

## Reporting Issues / Proposing Features

Before you submit an Issue or proposing a Feature check the existing Issues in order to avoid duplicates. <br>
Please make sure you provide enough information to work on your submitted Issue or proposed Feature:

* Which version of twtxt are you using?
* Which version of Python are you using?
* On which platform are you running twtxt?

## Pull Requests

We are very happy to receive Pull Requests! Please consider:

* Style Guide. Follow the rules of [PEP8](http://legacy.python.org/dev/peps/pep-0008/), but you may ignore *too-long-lines* and similar warnings.
* Tests. If our change affects Python code inside the source code directory, please make sure your code is covered by an automated test case.
* Documentation. If your change updates any interfaces, adds new features or change behavior please make sure the documentation is updated accordingly.

### Testing

You need to make sure *tox* and *pytest* are installed in you testing environment:

```bash
pyhon3 -m pip install tox pytest
```

To test the twtxt source code against all supported Python versions you should use *make test*:

```bash
cd ~/work/twtxt
make test
```

However, if you want to test your code manually in a certain environment use *virtualenv*:

```
cd ~/work/twtxt
virtualenv env -p python3.4
source env/bin/activate
python -m pip install --editable .
make pytest
```

### Documentation

The documentation can be generated using the `docs` rule in `make`:

```bash
make docs
```

The build directory of the documentation is located in *docs/_build/html*.
To open this documentation just open the *index.html* with your preferred browser:

```
firefox docs/_build/html/index.html
```

Add a Contribution file which is linked when created new Issues and Pull Requests
Add a Contribution file which is linked when created new Issues and Pull Requests
