Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 2.14 KB
Raw

Contributing

Request for changes/ Pull Requests

You first need to create a fork of the repository to commit your changes to it. Methods to fork a repository can be found in the GitHub Documentation.

Then add your fork as a local project:

# Using HTTPS
git clone https://github.com/jsonzilla/REPOSITORY.git

# Using SSH
git clone [email protected]:jsonzilla/REPOSITORY.git

Which remote URL should be used ?

Then, go to your local folder

cd github-issue-template

Add git remote controls :

# Using HTTPS
git remote add fork https://github.com/YOUR-USERNAME/REPOSITORY.git
git remote add upstream https://github.com/jsonzilla/REPOSITORY.git


# Using SSH
git remote add fork [email protected]:YOUR-USERNAME/REPOSITORY.git
git remote add upstream [email protected]/jsonzilla/REPOSITORY.git

You can now verify that you have your two git remotes:

git remote -v

Receive remote updates

In view of staying up to date with the central repository :

git pull upstream master

Choose a base branch

Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use master.

Type of change Branches
Documentation master or main
Bug fixes master or main
New features master or main
New issues models YOUR-USERNAME:patch 
# Switch to the desired branch
git switch master
# or
git switch main

# Pull down any upstream changes
git pull

# Create a new branch to work on
git switch --create patch/1234-name-issue

Commit your changes, then push the branch to your fork with git push -u fork and open a pull request on the REPOSITORY repository following the template provided.