70 lines
4.2 KiB
Markdown
70 lines
4.2 KiB
Markdown
# Contributing Guidelines
|
|
<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" width="500px">
|
|
|
|
[](https://discord.com/invite/26vT9wt3n3) [](https://github.com/DJj123dj/open-ticket/releases/tag/v4.0.0)
|
|
|
|
These are the Contributing Guidelines of Open Ticket!<br>
|
|
Here you can find everything you need to know about contributing to Open Ticket.<br>
|
|
This includes new features, translations & bug fixes.
|
|
|
|
### 💬 Translations
|
|
#### Step 1: View & Check
|
|
1. Check the [`./languages/`](./languages/) folder for existing translations.
|
|
2. When it doesn't exist yet, visit **[step 2](#step-2-translation)**.
|
|
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-translating)**.
|
|
|
|
#### Step 2: Translation
|
|
1. If your language doesn't exist yet, copy the [`english.json`](./../languages/english.json) file and rename it to your language.
|
|
2. You are allowed to use a little bit of `Google Translate` or `DeepL` when mentioned in the upload. (❌ Not Recommended)
|
|
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 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`](./../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:
|
|
- Create a pull request to the [__`dev` branch!__](https://github.com/DJj123dj/open-ticket/tree/dev)
|
|
- Create a ticket in our [discord server](https://discord.dj-dj.be)!
|
|
- Send a DM to @DJj123dj on discord!
|
|
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`](./../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](https://discord.dj-dj.be)!
|
|
|
|
### 🧩 Plugins (temporary)
|
|
Currently plugins can only be added to the list via our [discord server](https://discord.dj-dj.be)!
|
|
|
|
### 📦 Features (temporary)
|
|
Currently features can only be suggested in our [discord server](https://discord.dj-dj.be)!
|
|
|
|
### 🕷️ 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](https://discord.dj-dj.be)!
|
|
|
|
#### Please try to always include the `otdebug.txt` file!
|
|
|
|
---
|
|
<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" width="170px">
|
|
|
|
**Contributing Guidelines**<br>
|
|
[changelog](https://otgithub.dj-dj.be/releases) - [documentation](https://otdocs.dj-dj.be) - [tutorial](https://www.youtube.com/watch?v=2jK9kAf6ASU) - [website](https://openticket.dj-dj.be) - [discord](https://discord.dj-dj.be)<br>
|
|
|
|
© 2024 - [DJdj Development](https://www.dj-dj.be) - [Terms](https://www.dj-dj.be/terms#terms) - [Privacy Policy](https://www.dj-dj.be/terms#privacy) |