From 132d53583dd3ec26d8d36e79b675d7cb25deea85 Mon Sep 17 00:00:00 2001 From: luacs1998 Date: Wed, 19 Mar 2014 23:26:02 +0800 Subject: [PATCH 1/2] Create CONTRIBUTING.md Simple file (which github will show for those making PRs) containing guidelines for making PRs. Feel free to comment if you want/need anything added. I can pull the same thing to FML too if you'd like, Lex. --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c3e8b84ae --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +Contributing to Forge +===================== + +1) Keep patches to Minecraft classes minimal. If you need a lot of things done, you may either add to relevant forge classes or make a new class. + +2) An example mod must be provided for all PRs adding events/hooks to Forge. Whether it's a full mod using your proposed hooks, or just a pastebin containing a simple example, an example mod is required. + +3) Follow Forge coding guidelines (braces on newlines, etc) From 7f1b938cae8b927abef0a364467edbdb3a6cde53 Mon Sep 17 00:00:00 2001 From: luacs1998 Date: Wed, 19 Mar 2014 23:33:36 +0800 Subject: [PATCH 2/2] Update CONTRIBUTING.md Add link to wiki page on contributing --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3e8b84ae..0740941ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,8 @@ Contributing to Forge 1) Keep patches to Minecraft classes minimal. If you need a lot of things done, you may either add to relevant forge classes or make a new class. -2) An example mod must be provided for all PRs adding events/hooks to Forge. Whether it's a full mod using your proposed hooks, or just a pastebin containing a simple example, an example mod is required. +2) An example mod must be provided for all PRs adding events/hooks to Forge. Whether it's a full mod using your proposed hooks, or just a pastebin containing a simple example, an example mod is required. Please also explain in detail what your new hook does. -3) Follow Forge coding guidelines (braces on newlines, etc) +3) Follow Forge coding guidelines (braces on newlines, spaces instead of tabs, etc) + +For more information, refer to [the wiki](https://github.com/MinecraftForge/MinecraftForge/wiki/If-you-want-to-contribute-to-Forge)