Using GitHub for WET
Contributing on GitHub
In order to contribute to the WET project, you will have to use Git to commit your changes. The following is a explanation on using Git for this purpose. The image and steps below illustrate the process you will take when contributing to wet-boew.
- GitHub: An account with GitHub is required.
- Git client: In order to contribute to the project, you will need to download a Git client. There are a variety of different options, however, Git Bash is used in this tutorial.
- Ant: Apache Ant needs to be installed on the machine you are using with the environment variables configured correctly.
- Java SE: Java SE needs to be installed on the machine you are using with the environment variables configured correctly.
- Create a GitHub user name and password
- Open GIT Bash
- Set your user name and email address:
$ git config --global user.name "John Doe"
$ git config --global user.email email@example.com
Forking is copying an existing repository to another repository under your user name. If you do not have read + write privileges, this is the first step to contributing to WET.
- Fork an existing repository by going to the repository page on GitHub. In this case, you will want to navigate to: https://github.com/wet-boew/wet-boew.
- Click on the "Fork" button on the top right.
- This will create a copy of the repository on the GitHub website. This repository is under your user name and does not modify the original wet-boew repository if changes are made to it.
- Notice how the repository you forked was not called wet-boew/wet-boew? Your repository instead is called "yourusername"/wet-boew
Clone the project
Clone the project on your local machine to work on the project. This will copy all the files folders to your local machine.
$ git clone https://github.com/"yourusername"/wet-boew.git
Important: Whenever you want to make changes to a repository located on your computer (in this case your wet-boew clone), navigate to it using:
$ cd "repository name"
A remote is a repository stored on another computer, in this case on GitHub’s server.
When you clone a project, a default remote called "origin" is automatically created which points to your fork on GitHub (not the original repository).
It is important to point back to the original wet-boew repository by adding a new remote. (This remote is usually named "upstream", but you can call it whatever you want.) This will allow you to fetch the changes made to the original repository and add them to your fork.
$ git remote add upstream git://github.com/wet-boew/wet-boew.git
Get all of the changes to the WET repository and add them to your local machine using fetch and merge. The pull command does just that; it fetches the files and folders in the original wet-boew repository and attempts to merge it with the copy on your computer. You may have to fix any merge conflicts if they appear.
$ git pull upstream
Remove a remote
$ git remote rm upstream
In order to contribute back to the wet-boew/wet-boew project without any merge conflicts, you will have to set up a branch. A branch allows you to keep the WET files forked from wet-boew/wet-boew untouched while you work on your variation of these files.
Create a new branch and make it active ("myBranch" can be any name you specify):
$ git checkout -b myBranch
Switch between branches using checkout. Remember that "v3.1" is your main branch.
$ git checkout "branchname"
Once you’re finished working on your branch and are ready to combine it back into the v3.1 branch, use merge. Make sure you checkout to the v3.1 branch if you want to merge with the v3.1 branch.
$ git checkout v3.1
$ git merge myBranch
- You may see a variety of conflicts as you are doing this. Make sure to resolve these conflicts.
- Once you are finished with your branch, delete it using
git branch -d
Note: if you haven’t merged a branch, Git won’t let you delete it with this command; you’ll need to use an uppercase D in the option.
$ git branch -d branchname
A commit is essentially a snapshot of all the files in your project at a particular point in time. It is done locally, where you have stored your files, '''not''' on your GitHub repository. This means that you won't see any changes online - until you perform a push.
"Add" the files you want to capture in your commit.
$ git add fileorfolder
$ git add --allto add everything.
Commit your changes and add a message.
$ git commit -m " Whatever message you want to add "
Push to your fork
- You must push your changes from your local machine to your repository on GitHub's servers. Remember that "origin" is the remote that points to your forked repository on GitHub.
- "v3.1" or "vx.x" (e.g., v3.0) is the default branch name. You can create multiple branches, but the default is usually v3.1. More on that later.
$ git push -u origin v3.1
Remember that this push will update your fork of the original repository on GitHub, NOT the original repository itself.
Contribute to the original repository
In order to contribute back to the original repository (in this case wet-boew/wet-boew), you have to request that someone with read-write access to wet-boew/wet-boew take what you have in your fork and add it to their repository. This means that they will be performing a PULL (fetch and merge) of your forked repository.
In order to inform the wet-boew/wet-boew group to add your files from the fork, you can send the original author a pull request. A pull request is simply a notice asking them to pull from your fork.
- Navigate to your fork of the original repository on GitHub ("your user name"/wet-boew)
- Make sure that it is updated with all the content you'd like to add to the original repository.
- Click on the Pull Request button on the page and send your request.
If your request is accepted, your changes will be merged with the WET repository on GitHub.
- Date modified: