DiscordTickets/.github/CONTRIBUTING.md
Isaac (eartharoid) 4009daffbb minor edit
2020-08-24 17:27:28 +01:00

30 lines
1.8 KiB
Markdown

# Contributing
## Submitting issues
### Submitting a bug report
To submit a bug report, please use the "Bug report" template when creating a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose). Describe the bug in as much detail as possible, including how to reproduce the problem, using screenshots or code snippets if possible. Check that someone hasn't already filed an issue before creating another, you can comment on it if you want.
### Submitting a feature request
To submit a new feature request, please use the "Feature request" template when creating a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose).
### Submitting other issues
For issues not related to feature requests or bugs, you can [create a blank issue](https://github.com/eartharoid/DiscordTickets/issues/new). Please give us as much information as possible. If you just want to talk, you can join the [Discord server](https://github.com/eartharoid/DiscordTickets#support).
## Submitting a pull request
To contribute code to this project, create a new [pull request](https://github.com/eartharoid/DiscordTickets/pulls). For anything other than patches (bug fixes, documentation or minor code changes that have no affect on usage), such as a new feature, please create a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose) first, describing what you intend to change and why. Please ensure you update the documentation if needed.
When contributing, you should follow the same code style already used throughout, to ensure code is consistent.
1. Use single quote marks (`'`) when possible
2. Template literals are preferred
3. Commas should always have a space after them
4. Use tabs, not spaces, and always indent
5. Use arrow functions
**Note**: Create `user/dev.env` and `user/dev.config.js` for testing.