aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAikar <[email protected]>2020-06-20 15:51:03 -0400
committerAikar <[email protected]>2020-06-20 15:51:03 -0400
commitab2e8a853c58ed3f4a3ab2a41368adfaf073d8ac (patch)
tree5e514a2059ed753eb54fe74790049dccc9bd6cc9 /CONTRIBUTING.md
parentb2afcf1194f673c6609e793895aaa20d60433dcd (diff)
downloadPaper-ab2e8a853c58ed3f4a3ab2a41368adfaf073d8ac.tar.gz
Paper-ab2e8a853c58ed3f4a3ab2a41368adfaf073d8ac.zip
Add note to use Personal Forks and not Organization forks for PR's
Paper will routinely modify your PR for you to rebase it on latest or take care of any minor nitpicks that we can just solve for you instead of making you go back for a trivial item. However, if you use an Organization for the PR, this prevents Paper from doing this, and will require us to manually merge it and close the PR instead of it being marked as the purple merged. We much prefer to have merged PR's show as merged, so please do not use organizations repo's for PR as GitHub sadly does not support maintainers pushing to them. See [https://github.com/isaacs/github/issues/1681](https://github.com/isaacs/github/issues/1681)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1535f7b522..f38f840fb6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,6 +2,18 @@ Contributing to Paper
==========================
PaperMC has a very lenient policy towards PRs, but would prefer that you try and adhere to the following guidelines.
+## Use a Personal Fork and not Organization
+Paper will routinely modify your PR for you to rebase it on latest or take care of any minor nitpicks that we can
+just solve for you instead of making you go back for a trivial item.
+
+However, if you use an Organization for the PR, this prevents Paper from doing this, and will require us to manually
+merge it and close the PR instead of it being marked as the purple merged.
+
+We much prefer to have merged PR's show as merged, so please do not use organizations repo's for PR as GitHub sadly
+does not support maintainers pushing to them.
+
+See [https://github.com/isaacs/github/issues/1681](https://github.com/isaacs/github/issues/1681)
+
## Understanding Patches
Patches to Paper are very simple, but center around the directories 'Paper-API' and 'Paper-Server'