If you want to contribute but don't know how, and this file doesn't answer your questions, [start a discussion](https://github.com/eartharoid/DiscordTickets/discussions/new) or [join the Discord support & community server](https://go.eartharoid.me/discord) to ask for guidance.
Please read ["Welcome to DiscordTickets Discussions!"](https://github.com/eartharoid/DiscordTickets/discussions/77) before starting a discussion!
## Submitting a bug report
Issues should be used to report bugs. If you have found a bug, check to see if it has already been reported or resolved. If it hasn't, you can [create a new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose) using the "Bug report" template. Please include as much information as possible in your report.
## Submitting a feature request
To request a new feature, [start a new discussion](https://github.com/eartharoid/DiscordTickets/discussions/new?category=Ideas) under the Ideas category so other members of the community can discuss the request and vote on it.
If you would like to request changes to an existing feature, it may be better to [create an issue](https://github.com/eartharoid/DiscordTickets/issues/new) instead (use the `enhancement` label).
## Creating a pull request
To edit the documentation, translate, or contribute code to this project, you will need to [create a new pull request](https://github.com/eartharoid/DiscordTickets/compare). For large changes, you should **consider creating an issue** (or commenting on an existing one) first, as it could save you some time.
### Contributing code
Any code changes should be accompanied by any necessary documentation changes.
You should install the ESLint extension in your editor help you follow the code style.
- Use single quotes
- Functions should be named in camelCase
- Variables and constants should be named in snake_case
### Translating
Please try to keep the meaning of the translation as close to the original as possible.
1. Copy [`en-GB.json`](https://github.com/eartharoid/DiscordTickets/blob/master/src/locales/en-GB.json) and name it correctly
2. Without modifying the keys (left side of the colon), translate the values (on the right side of the colon).
3. [Create a pull request](#creating-a-pull-request)
### Updating documentation
#### Website
The documentation is written in Markdown, with extensions for additional features. See the [Material for MkDocs Reference](https://squidfunk.github.io/mkdocs-material/reference/abbreviations/) for details.
Please install a Markdown linting extension in your editor.
If you would like to see a live preview of your changes you can install MkDocs locally after cloning the repository (requires python).
1. Install with `pip install -r requirements.txt`
2. Run `mkdocs serve`
#### JSDoc
Feel free to improve or add JSDoc comments in the JavaScript files.
