Skip to content

Commit 5f44f1e

Browse files
committed
Merge remote-tracking branch 'upstream/dev/feature' into cjh/event/FertilizeEgg
2 parents 74cf6b4 + ce75dc9 commit 5f44f1e

File tree

1,239 files changed

+35351
-16194
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,239 files changed

+35351
-16194
lines changed

.editorconfig

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ root = true
66
end_of_line = lf
77
indent_style = tab
88
indent_size = 4
9-
charset = utf-8
9+
charset = utf-8
10+
11+
[*.{yaml,yml}]
12+
indent_style = space
13+
indent_size = 2

.gitattributes

Lines changed: 47 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,51 @@
1-
# .gitattributes snippet to force users to use same line endings for project.
2-
#
3-
# Handle line endings automatically for files detected as text
4-
# and leave all files detected as binary untouched.
5-
* text eol=lf
1+
# Handle line endings automatically for files detected as text
2+
# and leave all files detected as binary untouched.
3+
* text eol=lf
64

7-
#
8-
# The above will handle all files NOT found below
9-
# https://help.github.com/articles/dealing-with-line-endings/
10-
# https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes
5+
# The above will handle all files NOT found below
6+
# https://help.github.com/articles/dealing-with-line-endings/
7+
# https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes
118

9+
# These files are text and should be normalized (Convert crlf => lf)
10+
*.php text
11+
*.css text
12+
*.js text
13+
*.json text
14+
*.htm text
15+
*.html text
16+
*.xml text
17+
*.txt text
18+
*.ini text
19+
*.inc text
20+
*.pl text
21+
*.rb text
22+
*.py text
23+
*.scm text
24+
*.sql text
25+
*.htaccess text
26+
*.sh text
27+
*.java text
1228

29+
# These files are Windows-specific and should retain crlf
30+
*.bat text eol=crlf
1331

14-
# These files are text and should be normalized (Convert crlf => lf)
15-
*.php text
16-
*.css text
17-
*.js text
18-
*.json text
19-
*.htm text
20-
*.html text
21-
*.xml text
22-
*.txt text
23-
*.ini text
24-
*.inc text
25-
*.pl text
26-
*.rb text
27-
*.py text
28-
*.scm text
29-
*.sql text
30-
.htaccess text
31-
*.sh text
32-
*.java text
33-
34-
# These files are binary and should be left untouched
35-
# (binary is a macro for -text -diff)
36-
*.png binary
37-
*.jpg binary
38-
*.jpeg binary
39-
*.gif binary
40-
*.ico binary
41-
*.mov binary
42-
*.mp4 binary
43-
*.mp3 binary
44-
*.flv binary
45-
*.fla binary
46-
*.swf binary
47-
*.gz binary
48-
*.zip binary
49-
*.7z binary
50-
*.ttf binary
51-
*.pyc binary
52-
*.jar binary
53-
*.class binary
32+
# These files are binary and should be left untouched
33+
# (binary is a macro for -text -diff)
34+
*.png binary
35+
*.jpg binary
36+
*.jpeg binary
37+
*.gif binary
38+
*.ico binary
39+
*.mov binary
40+
*.mp4 binary
41+
*.mp3 binary
42+
*.flv binary
43+
*.fla binary
44+
*.swf binary
45+
*.gz binary
46+
*.zip binary
47+
*.7z binary
48+
*.ttf binary
49+
*.pyc binary
50+
*.jar binary
51+
*.class binary

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,6 @@
7070

7171
# EntityData
7272
/src/main/java/ch/njol/skript/entity @Absolutionism @skriptlang/core-developers
73+
74+
# Particles/Effects
75+
/src/main/java/org/skriptlang/skript/bukkit/particles @sovdeeth @skriptlang/core-developers

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ body:
77
## Guidelines
88
Please make sure you are running the latest version of Skript on a supported server platform and version.
99
Try to make sure there are no issues of this same problem currently open either.
10-
As of the release of Skript 2.13, the oldest supported version has been raised to Paper 1.20.4.
11-
Any issues created for versions older than 1.20.4, or for Spigot, will not be looked into or fixed unless the issue persists on supported versions.
10+
As of the release of Skript 2.14, the oldest supported version has been raised to Paper 1.21.0.
11+
Any issues created for versions older than 1.21.0, or for Spigot, will not be looked into or fixed unless the issue persists on supported versions.
1212
- type: textarea
1313
attributes:
1414
label: Skript/Server Version

.github/contributing.md

Lines changed: 132 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -26,72 +26,131 @@ Don't be scared to report real bugs, though. We won't be angry if we receive
2626
invalid reports; it is just that you're unlikely to get help with those here.
2727

2828
### Reporting Bugs
29-
So, you have found out a potential Skript bug. By reporting it correctly, you
30-
can ensure that it will be correctly categorized as a bug and hopefully, fixed.
3129

32-
First, please make sure you have **latest** Skript version available. If there
33-
are no stable (no pre-release tag) versions, this means latest dev build.
34-
If you can find non-prerelease in downloads page of this repository, you may
35-
also use that one. Do **not** use 2.2, 2.1 or older, since while they are
36-
technically stable, they tend to not work reliably with Minecraft 1.9+.
30+
First, please make sure you have **latest** Skript version available. This means
31+
the latest stable (non-prerelease) version available under the releases page.
32+
If you are reporting a bug specific to a prerelease version, please make sure you
33+
are using the latest prerelease. If the bug is already fixed in latest version,
34+
please do not report it.
3735

38-
Second, test without addons. No, seriously; unless you're an addon developer,
39-
test without plugins that hook to Skript before reporting anything. We can't
40-
help you with addon issues here, unless we get a lot of technical information
41-
about the addon in question. Issues that are not tested without addons are
42-
likely to be ignored by the core team.
36+
Second, test without addons. We won't help you with addon issues here.
37+
Issues that are not tested without addons are more likely to be ignored by the core team.
4338

4439
If the issue still persists, search the issue tracker for similar
4540
errors and check if your issue might have been already reported.
46-
Only if you can't find anything, open a new issue.
41+
Only if you can't find anything, open a new issue. If you are unsure,
42+
open the issue anyway; we can always close it if needed.
4743

4844
When opening an issue, pick a template for a bug report and fill it.
4945
We may ignore or close issues that are not made with correct templates.
46+
Please provide the full output of `/sk info` as requested in the template.
5047

5148
## Pull Requests
52-
Pull requests are a great way to contribute code, but there are still a few
53-
guidelines on how to use them.
5449

55-
Note that these guidelines do not apply to pull requesting changes to
56-
documentation. For that kind of pull requests, just use common sense.
57-
58-
### What to Contribute?
59-
You can find issues tagged with "help wanted" on tracker to see if there is
50+
### Pull Request Cheat Sheet
51+
A tl;dr version of the guidelines for contributing code:
52+
- Use the correct branch: `dev/feature` for new features or breaking changes, `dev/patch` for bug fixes and documentation changes.
53+
- Follow the code conventions. Disclose any AI assistance used.
54+
- Test your changes thoroughly, run the `quickTest` gradle task. Add more tests if possible.
55+
- Fill out the pull request template.
56+
- Respond to review comments in a timely and respectful manner.
57+
- Request re-reviews when you have addressed requested changes.
58+
- Feel free to politely ask for updates if your pull request has been open for a week or two without response.
59+
- Your contribution will be merged if it is ready prior to a release, so no need to worry.
60+
61+
### Choosing What to Work On
62+
You can find issues tagged with "good first issue" on tracker to see if there is
6063
something for you. If you want to take over one of these, just leave a comment
6164
so other contributors don't accidentally pick same issue to work on. You can also
62-
offer your help to any other issue, but for "help wanted" tasks, help is really
63-
*needed*.
65+
offer your help to any other issue you want to work on!
6466

65-
### Before Programming...
6667
If you did not pick an existing issue to work on, you should perhaps ask if your
67-
change is wanted. This can be done by opening an issue or contacting developer
68-
directly via Discord.
68+
change is wanted. Some changes may have already been considered and rejected, or
69+
may not fit into Skript's design goals. Opening an issue to discuss your idea is a good
70+
way to avoid wasted effort.
6971

7072
Then, a few words of warning: Skript codebase will not be pleasant, easy or
7173
that sane to work around with. You will need some Java skills to create anything
7274
useful in sane amount of time. Skript is not a good programming/Java learning
7375
project!
7476

75-
Still here? Good luck. If you did not learn how to use Git, now might be a good
76-
time to [learn](https://help.github.com/categories/bootcamp/).
77+
### Getting Started
78+
79+
We welcome contributions from everyone. To get started, please fork the repository
80+
and clone it to your local machine. If you are unfamiliar with Git, please refer to the
81+
[Git documentation](https://git-scm.com/learn).
82+
```
83+
git clone https://github.com/SkriptLang/Skript --recurse-submodules
84+
```
85+
86+
Create a new branch for your changes. Use a descriptive name for the branch,
87+
such as `feature/your-feature-name` or `patch/fix-issue-number`. We request that
88+
you base your changes on `dev/feature` branch for new features or breaking changes,
89+
and `dev/patch` branch for bug fixes and documentation changes.
90+
```
91+
git checkout -b feature/your-feature-name dev/feature
92+
git checkout -b patch/fix-issue-number dev/patch
93+
```
94+
95+
We recommend using an IDE such as IntelliJ (recommended) or Eclipse.
96+
Please also make sure to follow our [code conventions](https://github.com/SkriptLang/Skript/blob/master/code-conventions.md).
97+
98+
Building Skript requires Gradle. You can use the Gradle wrapper included in the
99+
repository to build Skript without installing Gradle globally.
100+
```
101+
./gradlew clean build
102+
```
103+
104+
Finally, we request that you write descriptive commit messages that summarize the changes.
105+
We do not enforce any specific format or style for commit messages, but we ask that they
106+
generally consist of more than `Fix bug`, `Add feature`, or `Updated FileClass.java`.
107+
108+
### AI assistance notice
109+
110+
> [!IMPORTANT]
111+
>
112+
> If you are using **any kind of AI assistance** to contribute to Skript,
113+
> it must be disclosed in the pull request.
77114
78-
### When Programming
79-
We recommend using an IDE; you can find some set up instructions in README.
80-
Please also follow our [code conventions](https://github.com/SkriptLang/Skript/blob/master/code-conventions.md).
115+
If you relied on AI assistance to make a pull request, you must disclose it in the
116+
pull request, together with the extent of the usage. For example, if you used
117+
AI to generate docs or tests, you must say it.
118+
An example disclosure:
119+
120+
- > This PR was written primarily by Claude Code.
121+
- > I consulted ChatGPT to understand the codebase but the solution
122+
> was fully authored manually by myself.
123+
124+
Providing this information helps reviewers understand the context of the
125+
pull request and apply the right level of scrutiny, ensuring a smoother
126+
and more efficient review process.
127+
128+
AI assistance isn't always perfect, even when used with the utmost care.
129+
130+
Please be respectful to maintainers and disclose AI assistance. Failure to do so
131+
may lead to rejection of the pull request or removal of your ability to contribute
132+
to the repository.
81133

82134
### After Programming
83135
Test your changes. Actually, test more than your changes: if you think that you
84136
might have broken something unrelated, better to test that too. Nothing is more
85-
annoying than breaking existing features.
137+
annoying than breaking existing features. Please run the `quickTest` gradle task prior
138+
to submitting your changes to ensure that existing tests pass.
139+
```
140+
./gradlew clean quickTest
141+
```
86142

87-
After manually testing, try to write some automated
143+
**After manually testing, try to write some automated
88144
[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.
145+
if possible**. Remember that not everything can be tested this way, though.
90146

91147
When you are ready to submit a pull request, please follow the template. Don't
92148
be scared, usually everything goes well and your pull request will be present
93149
in next Skript release, whenever that happens.
94150

151+
You should target the `dev/feature` branch for changes that add features or break existing functionality. \
152+
For bug fixes and documentation changes, target the `dev/patch` branch.
153+
95154
Good luck!
96155

97156
### Submitting a Contribution
@@ -101,32 +160,59 @@ Having submitted your contribution it will enter a public review phase.
101160
Other contributors and users may make comments or ask questions about your contribution. \
102161
You are encouraged to respond to these - people may have valuable feedback!
103162

104-
Developers may request changes to the content of your pull request. These are valuable since they may concern unreleased content. Please respect our team's wishes - changes are requested when we see room for improvement or necessary issues that need to be addressed.
163+
Developers may request changes to the content of your pull request. These are valuable
164+
since they may concern unreleased content. Please respect our team's wishes - changes
165+
are requested when we see room for improvement or necessary issues that need to be addressed.
105166
Change requests are not an indictment of your code quality.
106167

107-
Developers may also request changes to the formatting of your code and attached files. These are important to help maintain the consistent standard and readability of our code base.
168+
Developers may also request changes to the formatting of your code and attached files.
169+
These are important to help maintain the consistent standard and readability of our code base.
170+
171+
**You must respond to these requests**. You can disagree, or propose alternatives, but you must
172+
engage in the discussion respectfully and in a timely manner. We will close pull requests
173+
that do not address requested changes within 6 months, though this is at our discretion,
174+
and we may leave them open for more or less time depending on the situation.
108175

109-
Once you have made the requested changes (or if you require clarification or assistance) you can request a re-review from the developer.
176+
Once you have made the requested changes (or if you require clarification or assistance)
177+
you can request a re-review from the developer. Please make sure to resolve any requested
178+
changes you addressed.
110179

111-
You don't need to keep your pull request fork up-to-date with Skript's master branch - we can update it automatically and notify you if there are any problems.
180+
You don't need to keep your pull request fork up-to-date with Skript's master branch -
181+
we can update it automatically and notify you if there are any problems, but you must
182+
allow edits from maintainers on your pull request.
112183

113184
### Merging a Contribution
114185

115-
Pull requests may be left un-merged until an appropriate time (e.g. before a suitable release.) This timeframe may be increased for breaking changes or significant new features, which might be better targeted in a major version.
186+
Pull requests may be left un-merged until an appropriate time (e.g. before a suitable release.)
187+
We will try to merge contributions at a reasonable pace, but larger or more complex contributions
188+
may be left open for longer to allow for more thorough review.
116189

117-
Please respect the process - this is a very complex project that takes a lot of time and care to maintain. Your contribution has not been forgotten about.
190+
All pull requests that are ready to be merged prior to a release will be included in that release,
191+
so don't worry if your contribution is not merged immediately. If your pr has been open for a week
192+
without a response, feel free to politely ask for an update. We may be busy, but we will get to it.
118193

119-
For a contribution to be merged it requires at least two approving reviews from the core development team. It will then require a senior member to merge it.
194+
For a contribution to be merged it requires at least two approving reviews from the core development
195+
team. It will then require a senior member to merge it.
120196

121-
You do not need to 'bump' your contribution if it is un-merged; we may be waiting for a more suitable release to include it.
197+
You do not need to 'bump' your contribution if it is un-merged; we may be waiting for a more
198+
suitable release to include it.
122199

123-
If you have been waiting for a response to a question or change for a significant time please re-request our reviews or contact us.
200+
If you have been waiting for a response to a question or change for a significant time
201+
please re-request our reviews or contact us. **Don't be shy about requesting reviews!** It's
202+
one of the easiest ways for us to see what needs our attention.
124203

125-
In exceptional situations, pull requests may be merged regardless of review status by one of the organisation admins.
204+
In exceptional situations, pull requests may be merged regardless of review status
205+
by one of the organisation admins.
126206

127-
### Peaceful Resolution
207+
## Peaceful Resolution
128208

129209
Please respect our maintainers, developers, contributors and users. \
130-
Our contributors come from a wide variety of backgrounds and countries - you may need to explain issues and requests if they are misunderstood.
210+
Our contributors come from a wide variety of backgrounds and countries -
211+
you may need to explain issues and requests if they are misunderstood.
212+
213+
Please refer disrespectful and unpleasant behaviour to our tracker team.
214+
For concerns about abuse, please contact the organisation directly.
131215

132-
Please refer disrespectful and unpleasant behaviour to our tracker team. For concerns about abuse, please contact the organisation directly.
216+
## Acknowledgements
217+
We would like to acknowledge the [biomejs](https://github.com/biomejs/biome/blob/main/CONTRIBUTING.md#ai-assistance-notice)
218+
team as the source and inspiration for our AI assistance notice.

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@
1717
---
1818
**Completes:** none <!-- Links to issues or discussions that should be completed when this PR is merged. -->
1919
**Related:** none <!-- Links to issues or discussions with related information -->
20+
**AI assistance:** none <!-- Was AI assistance used in the creation of this PR? If so, please specify the tool and extent of usage. -->

0 commit comments

Comments
 (0)