diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3279a1d..875eca7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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! + +
+CONTRIBUTING GUIDELINES - Last updated: 23/3/2023
+© DJdj Development

+Website: https://www.dj-dj.be
+Discord: https://discord.dj-dj.be
+Email: support@dj-dj.be
+Open Ticket website: https://openticket.dj-dj.be diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index aa224f0..86254e7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,9 +1,9 @@ --- name: Bug report -about: Create a report to help us improve Open Ticket +about: Report bugs to help us improve open ticket! title: "[BUG] your bug" labels: bug -assignees: '' +assignees: DJj123dj --- diff --git a/.github/ISSUE_TEMPLATE/plugin.md b/.github/ISSUE_TEMPLATE/plugin.md index 7a08ce9..feb708f 100644 --- a/.github/ISSUE_TEMPLATE/plugin.md +++ b/.github/ISSUE_TEMPLATE/plugin.md @@ -1,9 +1,9 @@ --- name: Plugin -about: Show your open ticket plugins here! +about: Show your plugin to the developers from open ticket! title: "[PLUGIN] your plugin" labels: plugin -assignees: '' +assignees: DJj123dj --- diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..49e9f8b --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,41 @@ +# Security Policy + +## Supported Versions + +Support for Open Ticket is only available for the versions specified below! + +✅ Supported +🟧 Partially Supported +❌ Not Supported + +| Version | Supported | +| ------- | ------------------ | +| 3.3.1 | :white_check_mark: | +| 3.3.0 | 🟧 | +| 3.2.2 | 🟧 | +| < 3.2.2 | :x: | + +## Reporting a Vulnerability + +You can report Vulnerabilities, errors & bugs in the following ways: + +- Creating an issue on github +- Creating a ticket in our discord server +- Reporting the bug in DM on discord (DJj123dj#1706) +- Emailing support@dj-dj.be + +If your report an error, be clear about what is going on. +Specify the version & language of the bot together with when the error happend. (for example: when I click the close button) +Send screenshots from the error if possible, and send openticketdebug.txt (or a screenshot of it) to us. +Don't just report the error and never reply again! It can be possible that we need you for more information! + +## Contributing +Visit [Contributing.md](/.github/CONTRIBUTING.md) for rules about translating & adding features! + +
+SECURITY POLICY - Last updated: 23/3/2023
+© DJdj Development

+Website: https://www.dj-dj.be
+Discord: https://discord.dj-dj.be
+Email: support@dj-dj.be
+Open Ticket website: https://openticket.dj-dj.be diff --git a/config.json b/config.json index 1e7a03c..42d5aac 100644 --- a/config.json +++ b/config.json @@ -42,7 +42,7 @@ "adminroles":["role id"], "readonlyAdminroles":["role id"], "channelprefix":"question-", - "category":"category id", + "category":"category id (or leave empty)", "message":"You created a ticket!", "enableDmOnOpen":true, "ticketmessage":"The staff will help you soon!\n\n*Click on the button below to close the ticket!*", @@ -137,4 +137,4 @@ } } ] -} \ No newline at end of file +}