Upstream
/
Waterfall
mirror of https://github.com/PaperMC/Waterfall.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[ci-skip] Improving contributing file (#777)

This commit is contained in:
Andre_601 2023-03-31 07:25:50 +02:00 committed by GitHub
parent 2faf975aab
commit c0b3809024
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -35,21 +35,27 @@ 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.
8. Type `./waterfall rb` in the **main directory**.
- This will modify the appropriate patches based on your commits.
9. PR your modifications back to this project.
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.
@ -60,7 +66,10 @@ If you are simply editing a more recent commit or your change is small, simply m
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. PR your modifications to github
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