Contributing¶

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

Bug reports¶

Your operating system name and version.

Any details about your local setup that might be helpful in troubleshooting.

Detailed steps to reproduce the bug.

Documentation improvements¶

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

Feature requests and feedback¶

The best way to send feedback is to file an issue at https://github.com/Querela/python-transformer-discord-notifier/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 code contributions are welcome :)

Development¶

To set up python-transformer-discord-notifier for local development:

Fork python-transformer-discord-notifier (look for the “Fork” button).

Clone your fork locally:

git clone git@github.com:YOURGITHUBNAME/python-transformer-discord-notifier.git

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 run all the checks, tests and rebuild docs:
```
python setup.py check --strict --metadata --restructuredtext
check-manifest
flake8
isort --verbose --check-only --diff --filter-files src

sphinx-build -b doctest docs dist/docs
sphinx-build -b html docs dist/docs
sphinx-build -b linkcheck docs dist/docs

pytest
```
Or you can use tox to automatically run those commands:
```
tox
```
or just a single test:
```
tox -e check,docs
tox -e py38
```
Note, that the tests with pytest require a valid Discord token and channel. They must be provided as --discord-token token, --discord-channel chan or DISCORD_TOKEN=token, DISCORD_CHANNEL=chan.

You can set the environment variables in the .env file to make them visible to both pytest and tox environments.

If you use VSCode, configure it to use an environment variable file, in .vscode/settings.json the setting "python.envFile": "${workspaceFolder}/.env".

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¶

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

RUn extensive tests.
Update documentation when there’s new API, functionality etc.
Add a note to CHANGELOG.rst about the changes.
Add yourself to AUTHORS.rst.