mirror of
https://github.com/plexusorg/Plex-FAWE.git
synced 2024-12-23 01:37:37 +00:00
Created contributing.md and modify gh actions scripts
This commit is contained in:
parent
39faa740a2
commit
0419667bcc
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -15,4 +15,4 @@ You can do so here: https://github.com/IntellectualSites/FastAsyncWorldEdit-1.13
|
|||||||
- [] I included all information required in the sections above
|
- [] I included all information required in the sections above
|
||||||
- [] I tested my changes and approved their functionality
|
- [] I tested my changes and approved their functionality
|
||||||
- [] I ensured my changes do not break other parts of the code
|
- [] I ensured my changes do not break other parts of the code
|
||||||
- [] I read and followed the [contribution guidelines](https://github.com/IntellectualSites/FastAsyncWorldEdit-1.13/blob/breaking/CONTRIBUTING.md)
|
- [] I read and followed the [contribution guidelines](https://github.com/IntellectualSites/FastAsyncWorldEdit-1.13/blob/1.15/CONTRIBUTING.md)
|
||||||
|
4
.github/workflows/gradle.yml
vendored
4
.github/workflows/gradle.yml
vendored
@ -3,13 +3,9 @@ name: Java CI
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
|
||||||
- merge
|
|
||||||
- 1.15
|
- 1.15
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- master
|
|
||||||
- merge
|
|
||||||
- 1.15
|
- 1.15
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
69
CONTRIBUTING.md
Normal file
69
CONTRIBUTING.md
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
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.
|
||||||
|
|
||||||
|
* **Follow the [Oracle coding conventions](http://www.oracle.com/technetwork/java/codeconv-138413.html).**
|
||||||
|
We can't stress this enough; if your code has notable issues, it may delay
|
||||||
|
the process significantly.
|
||||||
|
* **Target Java 8 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.
|
||||||
|
* **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.
|
||||||
|
|
||||||
|
|
||||||
|
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`.
|
||||||
|
It allows you to modify existing commit messages, and combine, break apart, or
|
||||||
|
adjust past changes.
|
||||||
|
|
||||||
|
Example
|
||||||
|
-------
|
||||||
|
|
||||||
|
This is **GOOD:**
|
||||||
|
|
||||||
|
if (var.func(param1, param2)) {
|
||||||
|
// do things
|
||||||
|
}
|
||||||
|
|
||||||
|
This is **EXTREMELY BAD:**
|
||||||
|
|
||||||
|
if(var.func( param1, param2 ))
|
||||||
|
{
|
||||||
|
// do things
|
||||||
|
}
|
@ -15,12 +15,11 @@ FAWE is a fork of WorldEdit that has huge speed and memory improvements and cons
|
|||||||
|
|
||||||
## Downloads
|
## Downloads
|
||||||
### 1.13+
|
### 1.13+
|
||||||
* [Download](https://empcraft.com/fawe/download/)
|
* [Download](https://intellectualsites.github.io/download/fawe.html)
|
||||||
* [Jenkins](https://ci.athion.net/job/FastAsyncWorldEdit-Breaking/)
|
* [Jenkins](https://ci.athion.net/job/FastAsyncWorldEdit-1.15/)
|
||||||
* [JavaDoc](https://ci.athion.net/job/FastAsyncWorldEdit-1.13/javadoc/)
|
|
||||||
|
|
||||||
### < 1.12.2
|
### < 1.12.2
|
||||||
* [Download](https://empcraft.com/fawe/download/?bukkit)
|
* [Download](https://intellectualsites.github.io/download/fawe.html)
|
||||||
* [Jenkins](https://ci.athion.net/job/FastAsyncWorldEdit/)
|
* [Jenkins](https://ci.athion.net/job/FastAsyncWorldEdit/)
|
||||||
* [Repository](https://github.com/boy0001/FastAsyncWorldedit)
|
* [Repository](https://github.com/boy0001/FastAsyncWorldedit)
|
||||||
* [JavaDoc](https://ci.athion.net/job/FastAsyncWorldEdit/javadoc/)
|
* [JavaDoc](https://ci.athion.net/job/FastAsyncWorldEdit/javadoc/)
|
||||||
|
Loading…
Reference in New Issue
Block a user