CONTRIBUTING.md 2.46 KB
Newer Older
1
Contribution Guide
Henning Leutz's avatar
Henning Leutz committed
2 3
======

4 5
Guide: How to mix with QUIQQER - Contribution Guide
------
Henning Leutz's avatar
Henning Leutz committed
6

7
Thank you for taking the time to make QUIQQER better.
Henning Leutz's avatar
Henning Leutz committed
8

9 10
In order to keep it clear, we have established guidelines. They apply to QUIQQER and its extensions (packages). 
The guidelines are not carved in stone. We are always open to your changes to this document. 
Henning Leutz's avatar
Henning Leutz committed
11 12


13 14
Report bugs and issues
------
Henning Leutz's avatar
Henning Leutz committed
15

16 17 18
Every software has errors, including QUIQQER. Developers are also only human beings and so errors creep into the 
program code. We collect all errors and improvement requests at https://dev.quiqqer.com/. If you have errors 
or have any suggestions, please post them there. Please describe the error as exactly and in as much detail as possible. 
Henning Leutz's avatar
Henning Leutz committed
19

20 21
A screenshot often says more than a thousand words. Information about the browser version can also help. 
There is not too much information about an error.
Henning Leutz's avatar
Henning Leutz committed
22

23 24 25
Often we will go back to you in order to better understand the respective error. 
Therefore, please check your request frequently. As a rule, we will reply within one or two working days at the latest. 
Sometimes we need a few more days. Please be patient then.
Henning Leutz's avatar
Henning Leutz committed
26

27 28
Important, so that we can fully understand errors:
Answer our questions. After three months without feedback, we close the error.
Henning Leutz's avatar
Henning Leutz committed
29 30


31 32
Security vulnerabilities
-------
Henning Leutz's avatar
Henning Leutz committed
33

34 35
Security vulnerabilities will be resolved immediately. Please send security vulnerabilities directly to support@pcsg.de. 
Describe exactly what it is about. Please explain how the vulnerability can be exploited. 
Henning Leutz's avatar
Henning Leutz committed
36

37
You can also contact us in our Discord (https://discord.gg/tjWg4ZE).
Henning Leutz's avatar
Henning Leutz committed
38 39


40 41
For Developers
-------
Henning Leutz's avatar
Henning Leutz committed
42

43
If you want to help develop QUIQQER or even create your own module, have a look at our Discord (https://discord.gg/tjWg4ZE).
Henning Leutz's avatar
Henning Leutz committed
44

45 46
Please try to stick to the coding standards as well. We use coding styles and other coding standards so that everyone 
can develop quickly and worry-free. That makes it easier for everyone. 
Henning Leutz's avatar
Henning Leutz committed
47

48
### Coding Style
Henning Leutz's avatar
Henning Leutz committed
49

50
QUIQQER follows the PHP coding standard up to PSR-6 and uses JSHINT for JavaScript. Please stick to it as best you can. 
Henning Leutz's avatar
Henning Leutz committed
51

52
### Develop on QUIQQER
Henning Leutz's avatar
Henning Leutz committed
53

54 55
You want to develop directly at the core? That's great. But here we handle the standards extremely strictly, 
because this is the heart of a huge ecosystem. We gladly accept Pull Requests. 
Henning Leutz's avatar
Henning Leutz committed
56

57 58
Please submit all Pull Requests at >> https://dev.quiqqer.com/quiqqer/quiqqer <<. 
Pull Requests under Github are not accepted.
Henning Leutz's avatar
Henning Leutz committed
59

60
If you don't know how to start, we will be happy to help you. Just have a look at our Discord.