Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md file #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# **Guideliness for Contribution**
If you are contributing to the repository, then you should know the details of the following:
* Fork a repository
* Clone the repository
* Sync your fork
* About the Pull Request

## Fork a repository
To fork a repository means to copy that repository. By forking you can create the personal copy of any project. After this you can make changes according to your convenience and these changes will not affect the original project.
![alt](https://github-images.s3.amazonaws.com/help/bootcamp/Bootcamp-Fork.png)

## Clone the repository
In general clone means copied material which is exactly same as the original. In github, you can clone a repository to your local computer. Clonning a repository creates a local copy of the remote repo which allows you to edit the repo locally if you don't want to directly work on the source file of the original repo.
![alt](https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcQPc-Ko6cCrQQFfg7uugVuAsbBAAfKGpmmBrQ&usqp=CAU.png)

## Sync your fork
Before making pull request you must make sure that your fork is up to date or not. If your fork is behind on commits, then there are some changes in the repository where you are contributing. In this case you have to sync the fork.
![alt](https://www.earthdatascience.org/images/earth-analytics/git-version-control/github-commits-behind-master-abc.png)

### About the Pull Request process
When you know what changes you have to make in the project and after forking and clonning the repository you have to tell others about modifications you think should be there then you have to send a pull request.
For creating a pull request follow the steps
* After making changes you need to push them back to your repo.
* Click compare and then pull request.
* Click create pull request to open a new pull request.
![alt](https://storage.googleapis.com/cdn.thenewstack.io/media/2018/06/bd933597-propen.png)