Tinirau/open-ticket
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
76095bea30dc5ea17536ee47a28ce9fd1988ced5
open-ticket/.github/CONTRIBUTING.md
T
DJj123dj 7d5313c77e Open Ticket v4.1.1
2025-11-16 10:11:56 +01:00

5.4 KiB
Raw Blame History

Contributing Guidelines

Open Ticket Logo

discord version Sponsor DJj123dj

These are the Contributing Guidelines of Open Ticket!
Here you can find everything you need to know about contributing to Open Ticket.
This includes new features, translations & bug fixes.

💬 Translations

Step 1: View & Check

  1. Check the ./languages/ folder for existing translations.
  2. When it doesn't exist yet, visit step 2.
  3. When it does exist, check if it is outdated, incorrect or incomplete.
  4. If you match one of these requirements, you can also visit step 2.

Step 2: Translation

  1. If your language doesn't exist yet, copy the english.json file and rename it to your language.
  2. (❌ Not Recommended) You are allowed to use Google Translate or DeepL, but only when you say it in the pull request and enable the "automated" boolean.
  3. Only translate existing values in the json file. Don't add or remove any values from the file.
  4. You're NOT REQUIRED to translate everything! If you only want to translate a part of it, it's okay!
  5. If you are unable to translate something, leave it in English.

Step 3: Metadata

Metadata can be found in the _TRANSLATION variable.

Value Notes
otversion The Open Ticket version of this translation. ❌ DON'T EDIT!
translators The discord usernames from the translators. Add your name to the list when you've contributed.
lastedited The last edited date in the DD/MM/YYYY format.
language The full name of the language with capital letter.
automated Enable this boolean when this translation has been made using ChatGPT, Google Translate, ...

✅ You are also allowed to add your username to the README.md translator list!

Step 4: Uploading

  1. When adding a new language, please mention @DJj123dj. He will add the code required for the language to work.
  2. There are currently 3 ways of uploading translations:
  3. Now you'll need to wait until the next Open Ticket version for it to be added.

Step 5: Rewards

Translators get some rewards for translating Open Ticket!

  • ✅ Credits in the README.md translator list!
  • ✅ Credits in the changelog!
  • ✅ Credits in the documentation!
  • ✅ Credits in the translation JSON file!
  • ✅ A special role in our Discord server!

🧩 Plugins

Step 1: Creating Plugins

The documentation for creating plugins will be ready soon!
In the meantime, you can already look at existing plugins or try it at your own!

Step 2: Uploading Plugins

Create a pull request in the open-discord-plugins repository or contact DJj123dj in our Discord server!

📦 Features

Feature requests are required to be made in one of the following ways:

We won't accept pull requests for features. Only for bugs, small fixes, translation and plugins!

🕷️ Bug Fixes

You are able to report bugs in one of the following ways:

📌 If you want, you can also create a pull request to fix the bug yourself :)

🔴 Security Vulnerabilities

If you've found a bug which could affect the SECURITY OF THE BOT or may be potentially dangerous to the users of the bot, you are REQUIRED to send the bug privately via one of the following methods:

Please try to always include the otdebug.txt file!

Open Ticket Logo

Contributing Guidelines
Changelog - Documentation - Website - Support Server - License

© 2025 - DJdj Development - Terms - Privacy Policy - Support Us

Reference in New Issue View Git Blame Copy Permalink