You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/contributing.md
+51-5Lines changed: 51 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
# Contributing to HySkript
2
2
3
3
> [!IMPORTANT]
4
-
> This document is a work in progress.
4
+
> This document is a work in progress.
5
+
> Please check back regularly.
5
6
6
7
## Branches:
7
8
-`master` = Current release only
@@ -23,13 +24,18 @@ This way the team can discuss with you whether or not we want this in HySkript.
23
24
- Use descriptive commit messages
24
25
- Use descriptive PR titles
25
26
- Ensure you follow the code style of this project
27
+
- Do make sure you add tests and run the test to make sure it works.
28
+
- See the [Testing Guide](https://github.com/SkriptDev/HySkript/tree/master/src/test/README.md) for more information.
26
29
27
30
### Don't:
28
31
- Don't commit directly to `master`
29
32
- Don't use reflection (Hytale is pretty open)
30
33
- We won't accept PRs that are just string-based changes. Your PR contribution should be code-based. (If you find a typo, report it and/or let one of the team members know.)
31
34
- If a class seems outdated (in terms of formatting) please do not reformat the entire class for small changes (it makes PRs really difficult to read).
32
35
- Don't break any current syntaxes (ie: removing/changing a pattern with a breaking change).
36
+
- No chained expressions. These are really hard on the parser.
37
+
- Think of regular Skript and their ItemType chains
38
+
- Ex: `diamond sword of unbreaking 3 named "name" with lore "lore" with custom model data 1 .....`
33
39
34
40
## Code Style:
35
41
### Formatting:
@@ -44,12 +50,12 @@ This way the team can discuss with you whether or not we want this in HySkript.
44
50
45
51
### Naming
46
52
- Class names are written in UpperCamelCase
47
-
- The file name should match its primary class name (e.g. `MyClass` goes in `MyClass.java.`)
53
+
- The file name should match its primary class name (e.g. `MyClass` goes in `MyClass.java.`)
48
54
- Fields and methods named in `camelCase`.
49
-
- Static constant fields should be named in `UPPER_SNAKE_CASE`
55
+
- Static constant fields should be named in `UPPER_SNAKE_CASE`
50
56
- Use prefixes only where their use has been already established (such as `ExprSomeRandomThing`)
0 commit comments