aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGodOfPro <59516901+GodOfProDev@users.noreply.github.com>2022-10-21 21:01:59 +0330
committerGitHub <noreply@github.com>2022-10-21 19:31:59 +0200
commit2f57d3891a25630a41323c029bbe0b0a87d2fd33 (patch)
treee7d4f7b7f588a454ab7bb92577b7970f23be0eab /CONTRIBUTING.md
parent3168a7560a4d8f1d29c8f2518d674c1f4c85ef8c (diff)
downloadNotEnoughUpdates-2f57d3891a25630a41323c029bbe0b0a87d2fd33.tar.gz
NotEnoughUpdates-2f57d3891a25630a41323c029bbe0b0a87d2fd33.tar.bz2
NotEnoughUpdates-2f57d3891a25630a41323c029bbe0b0a87d2fd33.zip
Update CONTRIBUTING.md (#393)
* Update CONTRIBUTING.md I changed it so it specifies that you need to have a fork of the repo to contribute. * Update CONTRIBUTING.md * Update CONTRIBUTING.md Specifying you should make a new branch for every feature and not do it in the master branch like me * Update CONTRIBUTING.md * Update CONTRIBUTING.md changed pr to pull request and comitted to committed * Update CONTRIBUTING.md grammer Co-authored-by: jani270 <69345714+jani270@users.noreply.github.com> Co-authored-by: jani270 <69345714+jani270@users.noreply.github.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f46b50c8..f4840270 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -20,7 +20,11 @@ Ever since Moulberry has stopped working on NEU, other contributors have been wo
### Software configuration
-- Clone the NEU repository using `git clone https://github.com/NotEnoughUpdates/NotEnoughUpdates`.
+- Fork the NEU repository using the fork button on top right of the page and name the repo NotEnoughUpdates.
+- Clone the forked repository using `git clone https://github.com/<YourUserName>/NotEnoughUpdates`.
+- Make sure to create new branches for features you are working on and not commit to the master branch of your repository.
+- After you have committed all of the necessary changes make a pull request on that branch.
+- Use the master branch as a way to pull the latest changes from the NEU repo.
- Import that folder as a Gradle Project in your IDE (IntelliJ should autodetect it as gradle if you select the `NotEnoughUpdates` folder in the Open dialog)
- Set your project SDK to your 1.8 JDK. This can be done in the modules settings (CTRL+ALT+SHIFT+S) in IntelliJ.
- Set your gradle JVM to your 1.17 JDK. This can be done by searching for `gradle jvm` in the CTRL+SHIFT+A dialog in IntelliJ.