Contributing Guidelines

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

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

Step 2: Translation

If your language doesn't exist yet, copy the english.json file and rename it to your language.
You are allowed to use a little bit of Google Translate or DeepL when mentioned in the upload. (❌ Not Recommended)
Only translate existing values in the json file. Don't add or remove any values from the file.
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 this!
`translator`	The translator discord username. When improving existing translation, add your name to the list.
`lastedited`	The last edited date in the `DD/MM/YYYY` format.
`language`	The full name of the language with capital letter.

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

Step 4: Uploading

When adding a new language, please mention @DJj123dj. He will add the code required for the language to work.
There are currently 3 ways of uploading translations:
- Create a pull request to the dev branch!
- Create a ticket in our discord server!
- Send a DM to @DJj123dj on discord!
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 (temporary)

Currently plugins can only be added to the list via our discord server!

📦 Features (temporary)

Currently features can only be suggested in our discord server!

🕷️ Bug Fixes (temporary)

Currently bug fixes can only be reported in the following ways:

Create an issue in the repository!
Create a ticket in our discord server!

Please try to always include the `otdebug.txt` file!

Contributing Guidelines
changelog - documentation - tutorial - website - discord

4.1 KiB Raw Blame History