Hessenuk/DiscordTickets
Hessenuk/DiscordTickets
2
0
Fork 0
mirror of https://github.com/Hessenuk/DiscordTickets.git synced 2024-11-05 04:13:08 +02:00
Code Issues Packages Projects Releases Wiki Activity
18883d5d20
DiscordTickets/.github/CONTRIBUTING.md
Isaac 18883d5d20
do stuff
2021-02-22 00:05:37 +00:00

3.8 KiB
Raw Blame History

Contributing

Thank you for considering contributing to DiscordTickets.

Before contributing, please read the code of conduct, which all contributors must follow.

You don't need to write code to contribute; all contributions are welcome and encouraged. You could:

If you want to contribute but don't know how, and this file doesn't answer your questions, start a discussion or join the Discord support & community server to ask for guidance.

Issues are for:

  • Bug reports
  • Requesting changes to existing features

Please label your issues appropriately.

Discussions are for:

  • Support (also on Discord)
  • General questions (also on Discord)
  • Requesting new features

Please read "Welcome to DiscordTickets Discussions!" 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 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 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 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. 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 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

Updating documentation

Website

The documentation is written in Markdown, with extensions for additional features. See the Material for MkDocs Reference 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.