Skip to content

Latest commit

 

History

History
141 lines (94 loc) · 4.8 KB

CONTRIBUTING.md

File metadata and controls

141 lines (94 loc) · 4.8 KB
Raw

Contributing guidelines

To start contributing to jarvis-core project, please first discuss the change you wish to make via creating an issue in the issue section or any other method with the owners of this repository before making a change.
We have a code of conduct, please follow it in all your interactions with the project.

Contributing to jarvis-core

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

Steps to follow 📜

1. Fork it 🍴

You can get your own fork/copy of jarvis-core by using the Fork button.

Fork Button

2. Clone it 👥

You need to clone (download) it to local machine using

git clone https://github.com/Your_Username/jarvis-core.git

This makes a local copy of repository in your machine.

Once you have cloned the jarvis-core repository in GitHub, move to that folder first using change directory command.

# This will change directory to a folder jarvis-core
cd jarvis-core

Move to this folder for all other commands.

3. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in GitHub :octocat:

git remote -v
origin  https://github.com/Your_Username/jarvis-core.git (fetch)
origin  https://github.com/Your_Username/jarvis-core.git (push)

Now, add a reference to the original jarvis-core repository using

git remote add upstream https://github.com/the-vision/jarvis-core.git

This adds a new remote named upstream.

See the changes using

git remote -v
origin    https://github.com/Your_Username/jarvis-core.git (fetch)
origin    https://github.com/Your_Username/jarvis-core.git (push)
upstream  https://github.com/the-vision/jarvis-core.git (fetch)
upstream  https://github.com/the-vision/jarvis-core.git (push)

4. Sync it ♻️

Always keep your local copy of repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.

# Fetch all remote repositories and delete any deleted remote branches
git fetch --all --prune

# Switch to `master` branch
git checkout master

# Reset local `master` branch to match `upstream` repository's `master` branch
git reset --hard upstream/master

# Push changes to your forked `jarvis-core` repo
git push origin master

5. Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing by checking our Help Wanted Issues and creating pull requests.

6. Create a new branch ‼️

Whenever you are going to make contribution. Please create separate branch using command and keep your master branch clean (i.e. synced with remote branch).

# It will create a new branch with name Branch_Name and will switch to that branch.
git checkout -b Branch_Name

Create a separate branch for contribution and try to use same name of branch as of folder.

To switch to desired branch

# To switch from one folder to other
git checkout Branch_Name

To add the changes to the branch. Use

# To add all files to branch Branch_Name
git add .

Type in a message relevant for the code reviewer using

# This message gets associated with all files you have changed
git commit -m 'relevant message'

Now, Push your awesome work to your remote repository using

# To push your work to your remote repository
git push -u origin Branch_Name

Finally, go to your repository in browser and click on compare and pull requests. Use our pull request template format Then add a title and description to your pull request that explains your precious effort.

Sit and relax till we review your PR, you've made your contribution to our project.

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉