I thought our project had written instructions for creating PRs, but I looked and was unable to find them, so I drafted the following step-by-step. Probably this info should be added to Contributing.md.
Create an account at GitHub, if you don’t already have one. You can do this by browsing to https://github.com/, clicking on the “Sign up” button (upper right), and following the instructions.
Sign into GitHub, if you’re not already signed in. You can do this by browsing to https://github.com/, clicking on the “Sign in” button (upper right), and following the instructions.
Create your personal fork of the “jmonkeyengine” repository, if you don’t already have one. You can do this by browsing to https://github.com/jMonkeyEngine/jmonkeyengine, clicking on the “Fork” button (upper right), and following the instructions.
Clone the fork to your computer. Your IDE may provide an intuitive way of doing this. From a command prompt or shell, the following command should work: git clone https://github.com/yourGitHubUserName/jmonkeyengine.git
Create a branch for your changes. Your IDE may provide an intuitive way of doing this. From a command prompt or shell, the following commands should work:
cd jmonkeyengine
git checkout -b myPrBranch master
Make your changes to the new branch, using your IDE or text editor.
Test your changes. Testing should, at the very least, include building the Engine from scratch, using ./gradlew clean build or your IDE’s equivalent.
Add and commit your changes to the new branch.
Push the commit(s) to your fork at GitHub. Your IDE may provide an intuitive way of doing this. From a command prompt or shell, the following command should work: git push --set-upstream origin myPrBranch
One thing which I’m not fully understand (I’ll check git docs) is how to sync my fork with the original JME repo? let’s say after after a few weeks I wanna make sure that I have the latest JME updates before I create a new PR
AFAIK, “master” is not needed when creating a new branch. Just make sure you are in the correct base branch in which you wanna create your new branch from so if for example you wanna create a new branch from master then:
git checkout master
git checkout -b my_new_branch
[commit your new code]
git push origin my_new_branch
The way I manage my jme repo is I have two remotes. One for my github fork, and I leave origin as the official jme.githib repo.
This way I can create a new branch.
Warning: hand typed commands:
git checkout -b my-branch origin/master
Then make my changes. Then push to my repo: git push tlf30
This way, when I run a git pull, I get the latest copy of master from the official repo.
Ehhh… for some of this to make sense, you need to have multiple remotes configured. if you do a checkout from a remote without specifying a local branch, detached-head is exactly what you asked for. If you just want to see the master branch of your cloned repo, it already exists locally. git branch to see local branches. git status to see what’s currently happening. git checkout <branchname> to leave detached-head and go back to a branch.
If what you want is to pull down the latest of the JME project repository, you will need:
git remote --add upstream https://github.com/jMonkeyEngine/jmonkeyengine.gitgit remote add upstream https://github.com/jMonkeyEngine/jmonkeyengine.git. this tells git that you want to look at that repo, and to call it “upstream” for purposes of differentiating between remotes. This is a one-time setup command.
git fetch upstream and then git checkout -b upstream-head upstream/master. This creates a local branch that is set to automatically track the upstream master branch, calling it “upstream-head” locally. (You can pick a different local name if you want) This is also a one-time setup.
Before starting a new project branch, do: git checkout upstream-head and then git pull. This makes sure you are starting from the latest current engine master, which makes merging much easier later.
Start your project branch with git checkout -b <myProjectBranch> Creates a new branch starting at the current state of your upstream-head branch, and immediately checks it out.
When you’ve done some work (And committed your work!) you can run git push --set-upstream origin. This will push your work to your remote repository in a branch that matches your current local branch name. This is what you start a Pull Request from. If you then do further work in the local branch, you can push to the remote with git push.
Do be aware that github will insist on access tokens to allow pushing. They have a whole article on setting that up.
EDIT: fixed format for the remote add command, missed fetching upstream…
Oops. Sorry, I don’t use that command often - One-time per project, right? It should be git remote add upstream https://github.com/jMonkeyEngine/jmonkeyengine.git (Note the lack of dashes before the add)
EDIT: you also have to git fetch upstream before the git checkout -b upstream-head upstream/master command. As I said, I don’t have to use these that often.
