3
0
Mirror von https://github.com/IntellectualSites/FastAsyncWorldEdit.git synchronisiert 2024-12-25 02:20:07 +01:00

[ci skip] Move to org level templates

Dieser Commit ist enthalten in:
NotMyFault 2021-10-08 19:03:41 +02:00
Ursprung 2eb6451810
Commit d641e21dfc
Es konnte kein GPG-Schlüssel zu dieser Signatur gefunden werden
GPG-Schlüssel-ID: 158F5701A6AAD00C
9 geänderte Dateien mit 11 neuen und 144 gelöschten Zeilen

12
.github/FUNDING.yml vendored
Datei anzeigen

@ -1,12 +0,0 @@
# These are supported funding model platforms
github: [NotMyFault, dordsor21, SirYwell]
patreon: IntellectualSites # Replace with a single Patreon username
open_collective: IntellectualSites
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: https://www.paypal.me/AlexanderBrandes # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

Datei anzeigen

@ -1,19 +0,0 @@
## Overview
<!-- Please describe which issue this Pull Request targets
If there is no issue, please create one so we can look into it before approving your PR.
You can do so here: https://github.com/IntellectualSites/FastAsyncWorldEdit/issues
-->
<!-- Remove the brackets around the issue to connect your pull request with the issue it resolves -->
**Fixes #{issue number}**
## Description
<!-- Please describe what you have changed -->
## Checklist
<!-- Make sure you have completed the following steps (put an "X" between of brackets): -->
- [] I included all information required in the sections above
- [] I tested my changes and approved their functionality
- [] I ensured my changes do not break other parts of the code
- [] I read and followed the [contribution guidelines](https://github.com/IntellectualSites/FastAsyncWorldEdit/blob/main/CONTRIBUTING.md)

Datei anzeigen

@ -4,10 +4,12 @@ on: ["pull_request", "push"]
jobs:
build:
runs-on: "ubuntu-20.04"
runs-on: "ubuntu-latest"
steps:
- name: "Checkout Repository"
uses: "actions/checkout@v2.3.4"
- name : "Validate Gradle Wrapper"
uses : "gradle/wrapper-validation-action@v1.0.4"
- name: "Grab SHA"
uses: "benjlevesque/short-sha@v1.2"
id: "short-sha"
@ -17,11 +19,11 @@ jobs:
run: "echo $SHA"
env:
SHA: "${{ steps.short-sha.outputs.sha }}"
- name: "Setup JDK 16"
uses: "actions/setup-java@v2.2.0"
- name: "Setup Java"
uses: "actions/setup-java@v2.3.1"
with:
distribution: "temurin"
java-version: "16"
java-version: "17"
- name: "Clean Build"
run: "./gradlew clean build"
- name: Archive Artifacts

Datei anzeigen

@ -1,12 +0,0 @@
name: "validate gradle wrapper"
on: ["pull_request", "push"]
jobs:
build:
runs-on: "ubuntu-18.04"
steps:
- name: "Checkout Repository"
uses: "actions/checkout@v2.3.4"
- name: "Validate Gradle Wrapper"
uses: "gradle/wrapper-validation-action@v1.0.4"

Datei anzeigen

@ -6,7 +6,7 @@ but it needs some version of Java to bootstrap from.
Note that if you have JRE 8 installed, Gradle will currently attempt to use that to compile, which will not work. It is easiest to uninstall JRE 8 and replace it with JDK 16.
You can get the JDK 16 [here](https://adoptopenjdk.net/?variant=openjdk16&jvmVariant=hotspot).
You can get the JDK 16 [here](https://adoptium.net/).
The build process uses Gradle, which you do *not* need to download. FastAsyncWorldEdit is a multi-module project with three active modules:

Datei anzeigen

@ -1,91 +0,0 @@
Contributing
============
Thank you for your interest in contributing to FastAsyncWorldEdit! We appreciate your
effort, but to make sure that the inclusion of your patch is a smooth process, we
ask that you make note of the following guidelines.
* **Target Java 11 for source and compilation.** Make sure to mark methods with
` @Override` that override methods of parent classes, or that implement
methods of interfaces.
* **Use only spaces for indentation.** Our indents are 4-spaces long, and tabs
are unacceptable.
* **Wrap code to a 120 column limit.** We do this to make side by side diffs
and other such tasks easier. Ignore this guideline if it makes the code
too unreadable.
* **Write complete Javadocs.** Do so only for public methods, and make sure
that your `@param` and `@return` fields are not just blank.
* **Don't tag classes with @author.** Some legacy classes may have this tag,
but we are phasing it out.
* **Make sure the code is efficient.** One way you can achieve this is to spend
around ten minutes to think about what the code is doing and whether it
seems awfully roundabout. If you had to copy the same large piece of
code in several places, that's bad.
* **Annotate modified upstream (WorldEdit) code.** Doing so makes it easier to differentiate
between modifications. Take a look at the [Examples](#example) how that's been done.
* **Keep commit summaries under 70 characters.** For more details, place two
new lines after the summary line and write away!
* **Test your code.** We're not interested in broken code, for the obvious reasons.
* **Write unit tests.** While this is strictly optional, we recommend it for
complicated algorithms.
Additional Notes
----------------
If you're submitting a feature, base your code on `main` and PR against the
`main` branch.
Checklist
---------
Ready to submit? Perform the checklist below:
1. Have all tabs been replaced into four spaces? Are indentations 4-space wide?
2. Have I written proper Javadocs for my public methods? Are the @param and
@return fields actually filled out?
3. Have I `git rebase`d my pull request to the latest commit of the target
branch?
4. Have I combined my commits into a reasonably small number (if not one)
commit using `git rebase`?
5. Have I made my pull request too large? Pull requests should introduce
small sets of changes at a time. Major changes should be discussed with
the team prior to starting work.
6. Are my commit messages descriptive?
You should be aware of [`git rebase`](http://learn.github.com/p/rebasing.html).
It allows you to modify existing commit messages, and combine, break apart, or
adjust past changes.
Example
-------
### Code style
This is **GOOD:**
```java
if (var.func(param1, param2)) {
// do things
}
```
This is **VERY BAD:**
```java
if(var.func( param1, param2 ))
{
// do things
}
```
### Diff Annotations
```java
//FAWE start
public Region[] getCurrentRegions(FaweMaskManager.MaskType type) {
return WEManager.IMP.getMask(this, type);
}
//FAWE end
```
```java
//FAWE start - extends PassthroughExtent > implements Extent
public class EditSession extends PassthroughExtent implements AutoCloseable {
//FAWE end
```

Datei anzeigen

@ -36,7 +36,7 @@ For additional information about compiling FastAsyncWorldEdit, see [COMPILING.md
## Submitting Your Changes
FastAsyncWorldEdit is open source (specifically licensed under GPL v3), so note that your contributions will also be open source. The best way to submit a change is to create a fork on GitHub, put your changes there, and then create a "pull request" on our FastAsyncWorldEdit repository.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for important guidelines to follow.
Please read [CONTRIBUTING.md](https://github.com/IntellectualSites/.github/blob/main/CONTRIBUTING.md) for important guidelines to follow.
## YourKit
<a href="https://www.yourkit.com">

Datei anzeigen

@ -1,3 +0,0 @@
If you discover a security vulnerability in FastAsyncWorldEdit, please submit it through the [Security Vulnerability Form](https://forms.gle/btgdRn9yhGtzEiGW8).
Thanks for helping make FastAsyncWorldEdit safe for everyone.

Datei anzeigen

@ -23,5 +23,7 @@
"timezone": "Europe/Berlin",
"schedule": [
"on monday after 9am"
]
],
"labels": ["Renovate"],
"commitMessagePrefix": "chore: "
}