Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.91 KB

Contributing guidelines

First off, thank you very much for wanting to contribute to this project! Every single contribution is greatly appreciated. If you are unsure or intimidated by contributing, please do not be. You cannot submit a bad contribution.
The following contains a few points to help you get started. Please remember that these are guidelines, not strict rules.
Follow your common sense and you will be fine.

Code of conduct

You can find the code of conduct here.
Generally speaking, the rules of our discord server will also apply here.

Questions

If you just need to ask a question, head over to the GitHub Discussions Tab, join our discord server or send a DM to Phxenix.

Getting started with contributing

If you are just getting started, please read how to get the bot running in your environment.
Some knowledge of Python, discord.py, and other tools used would, of course, be beneficial.

Bug reports

Feel free to report bugs on discord (Contact methods above), or head over to the GitHub Issues Tab and fill out a new bug report. Choose whatever works for you. Please be descriptive in your explanation of the bug and how to reproduce it. If any error occurs, be sure to include the full traceback.

Pull requests

If this is your first time, consider reading the GitHub page about pull requests.
Please make sure you keep the scope of one pull request limited. If you want to adjust 2 unrelated things, please submit 2 pull requests.
Every pull requst is appreciated and no pull request is too small. Even if you only want to fix one typo, please go right ahead.
If you want to go above and beyond, it would be incredibly nice if you stick to the general style of this repository. Which brings us to:

Code style and tools

There are a few tools that are used in this repository to make your Python code look a lot cleaner. These are:

The settings can be found in the pyproject.toml file.

You do not meet one or more of these guidelines or are unsure of anything? Please, do not worry and submit your contribution anyways.
It will always be greatly appreciated.