Table of contents
Thank you for considering making a contribution to WhackDevelopment.
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:
- Submit a bug report issue
- Help with bug triage
- Request a new feature (or an improvement to an existing feature)
- Improve documentation (the website, or JSDoc comments)
- Help translate
- Create a tutorial (a video or page on the docs)
- Answer someone's question in Discussions
- Respond to an issue or pull request
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:
Please read "Welcome to WhackDevelopment Discussions!" before starting a discussion!
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.
To request a new feature for the bot, ask us on discord and submit an idea.
If you would like to request changes to an existing feature, it may be better to create an issue instead (use the enhancement label).
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.
You should name your commits using this commit message format.
Any code changes should be accompanied by any necessary documentation changes.
You should install the ESLint extension in your editor to help you follow the code style.
- Indentation should use tabs not spaces
- Classes should be named in PascalCase
- Functions should be named in camelCase
- Variables and constants should be named in snake_case
- Use the latest JS features (destructuring, arrow functions etc)
Please try to keep the meaning of the translation as close to the original as possible. If you want to change the meaning, you can customise your locale files after.
-- Not Available --
Feel free to improve or add JSDoc comments in the JavaScript files.