111 lines
5.6 KiB
Markdown
111 lines
5.6 KiB
Markdown
Contributing to Waterfall
|
|
==========================
|
|
WaterfallMC has a very lenient policy towards PRs, but would prefer that you try and adhere to the following guidelines.
|
|
|
|
## Understanding Patches
|
|
Patches to Waterfall are very simple, but center around the directory 'Waterfall-Proxy'
|
|
|
|
Assuming you already have forked the repository:
|
|
|
|
1. Pull the latest changes from the main repository
|
|
2. Type `./waterfall p` in git bash to apply the changes from upstream
|
|
3. cd into `Waterfall-Proxy` for proxy changes
|
|
|
|
This directory is not a git repository in the traditional sense:
|
|
|
|
- Every single commit in Waterfall-Proxy is a patch.
|
|
- 'origin/master' points to a directory similar to Waterfall-Proxy but for Waterfall
|
|
- Typing `git status` should show that we are 10 or 11 commits ahead of master, meaning we have 10 or 11 patches that Waterfall and Bungeecord don't
|
|
- If it says something like `212 commits ahead, 207 commits behind`, then type `git fetch` to update Waterfall
|
|
|
|
## Adding Patches
|
|
Adding patches to Waterfall is very simple:
|
|
|
|
1. Modify `Waterfall-Proxy` with the appropriate changes
|
|
2. Type `git add .` to add your changes
|
|
3. Run `git commit` with the desired patch message
|
|
4. Run `./waterfall rb` in the main directory to convert your commit into a new patch
|
|
5. PR your patches back to this repository
|
|
|
|
Your commit will be converted into a patch that you can then PR into Waterfall
|
|
|
|
## Modifying Patches
|
|
Modifying previous patches is a bit more complex:
|
|
|
|
### Method 1
|
|
This method works by temporarily resetting HEAD to the desired commit to edit using rebase.
|
|
|
|
Make sure to be in the `Waterfall-Proxy` directory for the following steps.
|
|
|
|
1. If you have changes you are working on type `git stash` to store them for later.
|
|
- Later you can type `git stash pop` to get them back.
|
|
2. Type `git rebase -i upstream/upstream`
|
|
- It should show something like [this](https://gist.github.com/electronicboy/6241e511c4a1f5d3e0217be1d742ff6a).
|
|
3. Replace `pick` with `edit` for the commit/patch you want to modify, and "save" the changes.
|
|
- Only do this for one commit at a time.
|
|
- Commits/Patches are in order for when they were made, so if you f.e. want to modify patch 0003, you would pick commit 3 in the list.
|
|
4. Make the changes you want to make to the patch.
|
|
5. Type `git add .` to add your changes.
|
|
6. Type `git commit --amend` to commit.
|
|
- **MAKE SURE TO ADD `--amend`** or else a new patch will be created.
|
|
- You can also modify the commit message here.
|
|
7. Type `git rebase --continue` to finish rebasing.
|
|
8. Type `./waterfall rb` in the **main directory**.
|
|
- This will modify the appropriate patches based on your commits.
|
|
9. Type `git add .` to add your changes.
|
|
10. Type `git commit` to commit.
|
|
11. Push the changes to your fork with `git push`
|
|
12. PR your modifications back to this project.
|
|
|
|
### Method 2 (sometimes easier)
|
|
If you are simply editing a more recent commit or your change is small, simply making the change at HEAD and then moving the commit after you have tested it may be easier.
|
|
|
|
1. Make your change while at HEAD
|
|
2. Make a temporary commit. You don't need to make a message for this.
|
|
3. Type `git rebase -i upstream/upstream`, move (cut) your temporary commit and move it under the line of the patch you wish to modify.
|
|
4. Change the `pick` with `f` (fixup) or `s` (squash) if you need to edit the commit message
|
|
5. Type `./waterfall rb` in the main directory
|
|
- This will modify the appropriate patches based on your commits
|
|
6. Type `git add .` to add your changes.
|
|
7. Type `git commit` to commit.
|
|
8. Push the changes to your fork with `git push`
|
|
9. PR your modifications to github
|
|
|
|
|
|
## PR Policy
|
|
We'll accept changes that make sense. You should be able to justify their existence, along with any maintenance costs that come with them. Remember, these changes will affect everyone who runs Waterfall, not just you and your server.
|
|
While we will fix minor formatting issues, you should stick to the guide below when making and submitting changes.
|
|
|
|
## Formatting
|
|
All modifications to non-Waterfall files should be marked
|
|
- Multi line changes start with `// Waterfall start` and end with `// Waterfall end`
|
|
- You can put a messages with a change if it isn't obvious, like this: `// Waterfall start - reason`
|
|
- Should generally be about the reason the change was made, what it was before, or what the change is
|
|
- Multi-line messages should start with `// Waterfall start` and use `/* Multi line message here */` for the message itself
|
|
- Single line changes should have `// Waterfall` or `// Waterfall - reason`
|
|
- For example:
|
|
````java
|
|
return getConfig().getNotStupid(); // Waterfall - was return getConfig().getStupid();
|
|
|
|
// Waterfall start
|
|
// con.disconnect( bungee.getTranslation( "lost_connection" ) );
|
|
ServerInfo def = con.updateAndGetNextServer( server.getInfo() );
|
|
ServerKickEvent event = bungee.getPluginManager().callEvent( new ServerKickEvent( con, server.getInfo(), TextComponent.fromLegacyText( bungee.getTranslation( "lost_connection" ) ), def, ServerKickEvent.State.CONNECTED, ServerKickEvent.Cause.LOST_CONNECTION ) );
|
|
if ( event.isCancelled() && event.getCancelServer() != null )
|
|
{
|
|
server.setObsolete( true );
|
|
con.connectNow( event.getCancelServer() );
|
|
}
|
|
else
|
|
{
|
|
con.disconnect0( event.getKickReasonComponent() );
|
|
}
|
|
// Waterfall end
|
|
````
|
|
- We generally follow usual java style, or what is programmed into most IDEs and formatters by default
|
|
- This is also known as oracle style
|
|
- It is fine to go over 80 lines as long as it doesn't hurt readability
|
|
- There are exceptions, especially in Bungeecord-related files
|
|
- When in doubt, use the same style as the surrounding code
|
|
|