1
1
# Contributing to Skript
2
- Skript is an open source project. That basically means that you are
3
- encouraged to contribute by reporting issues and writing code. Basic
4
- guidelines are posted below to save time from everyone.
2
+ Skript is an open source project, and you're encouraged to contribute to it.
3
+ Both reporting issues and writing code help us. However, please review the
4
+ following guidelines * before* doing either of these. Properly created issues
5
+ and pull requests are often resolved faster than those that ignore them.
6
+
7
+ ## Behavior
8
+ Please treat others with respect in the issue tracker and comments of pull
9
+ requests. We hope that you are a decent person and do this without telling.
10
+ Failing that, issues where inappropriate behavior is observed may be ignored
11
+ closed or even deleted. Repeated or particularly egregious behavior will get
12
+ you banned from issue trackers of SkriptLang organization.
13
+
14
+ Access to Skript's source code is a right that everyone with a binary release
15
+ of it has. Access to our communications platforms is a * privilege* that will
16
+ be taken away if misused.
5
17
6
18
## Issues
7
19
Issues are usually used to report bugs and request improvements or new features.
@@ -13,9 +25,6 @@ are SkUnity forums and Discord (see README again).
13
25
Don't be scared to report real bugs, though. We won't be angry if we receive
14
26
invalid reports; it is just that you're unlikely to get help with those here.
15
27
16
- Oh, and one more thing: please avoid being offensive in Skript's issue tracker.
17
- It doesn't help anyone and may also get you banned.
18
-
19
28
### Reporting Bugs
20
29
So, you have found out a potential Skript bug. By reporting it correctly, you
21
30
can ensure that it will be correctly categorized as a bug and hopefully, fixed.
@@ -29,21 +38,15 @@ technically stable, they tend to not work reliably with Minecraft 1.9+.
29
38
Second, test without addons. No, seriously; unless you're an addon developer,
30
39
test without plugins that hook to Skript before reporting anything. We can't
31
40
help you with addon issues here, unless we get a lot of technical information
32
- about the addon in question. Usually only developers of them know addons'
33
- Java code well enough .
41
+ about the addon in question. Issues that are not tested without addons are
42
+ likely to be ignored by the core team .
34
43
35
44
If the issue still persists, search the issue tracker for similar
36
45
errors and check if your issue might have been already reported.
37
46
Only if you can't find anything, open a new issue.
38
47
39
- Now, what would you fill to the issue report?
40
- * A useful title (tl;dr for us busy and/or lazy developers)
41
- * Description of the issue, aka what does * not* work
42
- * Any error messages in the console (please use a paste service for lenghty errors)
43
- * Whether you tested without addons or not
44
- - * Sometimes* we do not ignore people who are testing with addons
45
- - Testing without is still better, unless you're an addon developer
46
- * Any additional information you think would be helpful
48
+ When opening an issue, pick a template for a bug report and fill it.
49
+ We may ignore or close issues that are not made with correct templates.
47
50
48
51
## Pull Requests
49
52
Pull requests are a great way to contribute code, but there are still a few
@@ -74,29 +77,28 @@ time to [learn](https://help.github.com/categories/bootcamp/).
74
77
75
78
### When Programming
76
79
We recommend using an IDE; you can find some set up instructions in README.
77
- Also, please follow our CODING_CONVENTIONS .
80
+ Please also follow our [ code conventions ] ( https://github.com/SkriptLang/Skript/blob/master/.github/code-conventions.md ) .
78
81
79
82
### After Programming
80
83
Test your changes. Actually, test more than your changes: if you think that you
81
84
might have broken something unrelated, better to test that too. Nothing is more
82
85
annoying than breaking existing features.
83
86
87
+ After manually testing, try to write some automated
88
+ [ test scripts] ( https://github.com/SkriptLang/Skript/blob/master/src/test/skript/README.md )
89
+ if possible. Remember that not everything can be tested this way, though.
90
+
84
91
When you are ready to submit a pull request, please follow the template. Don't
85
92
be scared, usually everything goes well and your pull request will be present
86
- in next Skript release.
93
+ in next Skript release, whenever that happens .
87
94
88
95
Good luck!
89
96
90
- ### Insight: Pull Request Review
91
- Pull requests will be reviewed before they are merged.
92
- This includes testing the code, but * no* debugging if it doesn't work;
93
- please test your code before submitting a pull request.
94
-
95
- The reviews are done by Skript developers with push access, but you're
96
- likely to get others to give feedback too. If you're asked about something,
97
- please answer - even if it is not us asking.
97
+ ### Pull Request Review
98
+ Pull requests require one passing review before they can be merged. In
99
+ addition to that, code submitted by people outside of core team must be tested
100
+ by core team members. In some cases, this might be as simple as running the
101
+ automated tests.
98
102
99
- ## Code Bounties
100
- Just to let you know, [ Bountysource] ( https://www.bountysource.com/ ) is a thing.
101
- While it has not ever happened, you could post a bounty on an issue to make
102
- someone potentially do it faster.
103
+ In exceptional situations, pull requests may be merged regardless of review
104
+ status by @bensku .
0 commit comments