Update CONTRIBUTING.md

2023-03-23 14:10:03 +01:00
parent a8c9c2ea8d
commit a041f28cf7
1 changed files with 42 additions and 3 deletions
@@ -1,3 +1,42 @@
-# comming soon
-For now on, you can create a ticket in our server:
-https://discord.dj-dj.be
+# Contributing
+## Translation
+### Step 1: checking
+1. [Check if the language isn't already in open ticket!](/language/)
+2. Check if the current translation is up-to-date!
+3. Can you edit/write JSON?
+
+If there is translation missing & you can write json, then go to the next step!
+
+### Step 2: translating
+**RULES:**
+- Always upload to the [__`dev` branch!__](https://github.com/DJj123dj/open-ticket/tree/dev)
+- Don't change anything else, except the translation you are adding!
+- Translations are checked before uploading, so don't write things that aren't specified in the json file
+- Always start translating from `english.json` or `custom.json`! Never from another language.
+
+If you translate, you need to change 2 files! The first one is required, the other one is optional & will be added by us if you don't do it!
+1. add `yourlanguage.json` to the `/language/` directory
+2. (OPTIONAL) add your discord name & tag in the translator table in `README.md`
+
+### Step 3: waiting
+Translations will always be added in the **next version** of Open Ticket! They will never be added to the `main` branch directly without anything else! This means that it can take some time before your translation is in the official version!
+
+## Writing plugins
+We are going to create an official repository for plugins soon!
+But don't worry! You can already write some plugins!
+
+**RULES:**
+- Always specify the versions that the plugin is compatible with!
+- If extra npm dependencies are needed, then they also need to be specified!
+- If there are errors while you write a plugin/edit the code in some way. Then we can't help you with fixing the bug. We only fix bugs that are part of an unedited version of Open Ticket!
+
+## Other versions of contributing
+If you want to contribute in another way, feel free to join [our discord server](https://discord.dj-dj.be) & talk about how you are going to do it. We will always help you!
+
+<br>
+CONTRIBUTING GUIDELINES - Last updated: 23/3/2023<br>
+© DJdj Development<br><br>
+Website: https://www.dj-dj.be <br>
+Discord: https://discord.dj-dj.be <br>
+Email: support@dj-dj.be <br>
+Open Ticket website: https://openticket.dj-dj.be