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/thorgate/tg-react/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” is open to whoever wants to implement it.

Implement Features¶

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

Write Documentation¶

tg-react could always use more documentation, whether as part of the official tg-react 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/thorgate/tg-react/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 :)

Translate¶

Add a new locale using:

$ LOCALE='<locale>' make add-locale

This will create a new directory under tg_react/locale/<locale> and a django.po file inside it. First edit the comments and the PO file header of the generated file (use tg_react/locale/en/LC_MESSAGES/django.po for refrence) and then use tools like Poedit to add translations.

After you are done, update compiled translations via:

$ make update-messages

Get Started!¶

Ready to contribute? Here’s how to set up tg-react for local development.

Fork the tg-react repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/tg-react.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 tg-react
$ cd tg-react/
$ 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:
```
$ make lint
$ make test
$ make test-all
```
To get flake8 and tox, just pip install them into your virtualenv:
```
$ pip install -r requirements-test.txt
```

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. You should also update the documentation source files via:
```
$ make docs
```
If the pull request modifies/adds translations don’t forget to run:
```
$ make update-messages
```
The pull request should work for Python 2.7, 3.4, 3.5 and 3.6. Check https://travis-ci.org/thorgate/tg-react/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

Run full test suite via tox (all python and django version combinations):

$ make test-all

To run a subset of tests:

$ py.test tests.test_tg_react

Update documentation source files and generate it:

$ make docs

To see all make commands:

$ make help