Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

113 lines (71 loc) · 3 KB

We are glad to know that you have decided to contribute to this repository 🥳🥳 .If you are looking to make your first contribution, follow the steps below.

fork this repository

If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

clone this repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

copy URL to clipboard

For example:

git clone https://github.com/monizb/FireShort.git

where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

Create a branch

Change to the repository directory on your computer:

cd FireShort

Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

For example:

git checkout -b Contributors

Make necessary changes and commit those changes

 git add Name of the file you just created or edited

git status

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

For example:

git add Contributors.md

Now commit those changes using the git commit command:

For example:

git commit -m "Added Contributors.md"

Push changes to GitHub

Push your changes using the command git push:

git push origin your-branch-name

replace your-branch-name with the name of the branch you created earlier.

Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

create a pull request

Now submit the pull request.

submit pull request

If your changes are correct then we will merge all your changes into the master branch of this project. You will get a notification email once the changes have been merged.

Spammy and low value PRs which fix typos and whitespaces will be labeled invalid and will NOT count towards your Hacktoberfest contributions