Contributing Guidelines - AyranIsTheNewRaki/Herodot GitHub Wiki

Create a local clone of your fork

  • Fork the repository.

Fork

  • Navigate to your fork of the Herodot repository and click Clone or download.

Clone or download

  • Copy the clone URL for the repository.

  • Open Git Bash.

  • Change directories to the location where you want the local project folder will be created.

  • Type git clone, and then paste the clone URL you copied. It will look like this, with your GitHub username instead of YOUR-USERNAME:

git clone https://github.com/YOUR-USERNAME/Herodot

  • Press Enter. Your local clone will be created.

Sync your fork with the original Herodot repository

  • Open Git Bash.

  • Change directories to the location of the fork you cloned.

  • Type git remote -v and press Enter. You'll see the current configured remote repository for your fork.

Current Remote

  • Type git remote add upstream, and then paste the URL you copied from the original repository:

git remote add upstream https://github.com/AyranIsTheNewRaki/Herodot.git

  • To verify the new upstream repository you've specified for your fork, type git remote -v again. You should see the URL for your fork as origin, and the URL for the original repository as upstream.

New Upstream

Keep your local fork up-to-date

  • Navigate to your local master branch.

git checkout master

  • Fetch the branches and their respective commits from both upstream and local repositories.

git fetch --all

  • Merge the changes from upstream/master into your local master branch. This brings your fork's master branch into sync with the upstream repository, without losing your local changes.

git merge upstream/master

Making Changes and Creating Pull Requests

  • Never work on your master branch even if it is your local master. First sync your local master with upstream/master and branch off a feature branch from local master by typing:

git checkout -b myfeaturebranch master

  • Make your changes and commit. (If your commit is related to an issue, please add issue reference number to your commit)

  • Push your changes.

  • Submit a pull request as described here.

References