From d641e21dfcf4490ad9842e509e8fe0ce01f410ba Mon Sep 17 00:00:00 2001 From: NotMyFault Date: Fri, 8 Oct 2021 19:03:41 +0200 Subject: [PATCH] [ci skip] Move to org level templates --- .github/FUNDING.yml | 12 --- .github/PULL_REQUEST_TEMPLATE.md | 19 ---- .github/workflows/build.yml | 10 +- .github/workflows/validate-gradle-wrapper.yml | 12 --- COMPILING.md | 2 +- CONTRIBUTING.md | 91 ------------------- README.md | 2 +- SECURITY.md | 3 - renovate.json | 4 +- 9 files changed, 11 insertions(+), 144 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/validate-gradle-wrapper.yml delete mode 100644 CONTRIBUTING.md delete mode 100644 SECURITY.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 67079dc67..000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -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'] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6277f3cd9..000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,19 +0,0 @@ -## Overview - - - -**Fixes #{issue number}** - -## Description - - -## Checklist - -- [] 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) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6865877ef..041f8fa0d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -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 diff --git a/.github/workflows/validate-gradle-wrapper.yml b/.github/workflows/validate-gradle-wrapper.yml deleted file mode 100644 index 7463dca05..000000000 --- a/.github/workflows/validate-gradle-wrapper.yml +++ /dev/null @@ -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" diff --git a/COMPILING.md b/COMPILING.md index dbad3f134..0f2f9faa4 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -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: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 9c915669a..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -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 -``` diff --git a/README.md b/README.md index 799a63964..d5f0ffe60 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 5fdc208e0..000000000 --- a/SECURITY.md +++ /dev/null @@ -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. diff --git a/renovate.json b/renovate.json index dbe6bc436..006892596 100644 --- a/renovate.json +++ b/renovate.json @@ -23,5 +23,7 @@ "timezone": "Europe/Berlin", "schedule": [ "on monday after 9am" - ] + ], + "labels": ["Renovate"], + "commitMessagePrefix": "chore: " }