Skip to content

Latest commit

 

History

History
117 lines (73 loc) · 4.63 KB

CONTRIBUTING.md

File metadata and controls

117 lines (73 loc) · 4.63 KB

Open Source Love License: Apache 2.0

Contributions

All contributions are governed by the covenant.

Fork this repository

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

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

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the clone 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.

For example:

git clone https://github.com/this-is-you/project.git

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

Finally, change to the repository directory on your computer (if you are not already there):

cd project

Create a branch

Now create a branch using the git checkout command:

git checkout -b <a-branch-name>

For example:

git checkout -b add-block-class

(The name of the branch does not need to have the word add in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)

Make necessary changes and commit those changes

Now make your changes. If you move files around, keep the history of the file in-tact by using:

git mv path-to-file.ext path-to-file-new.ext

For each force you add, see if you can add some tests. For each match parser you add, see if you can add a few examples to the repo which parse and don't parse.

Finally, stage each file you've changed.

git add path-to-file.ext

Now commit those changes using the git commit command:

git commit -m "<Past tense verb> <Phrase>"

replacing <Past tense verb> with the main action you took, followed by some <Phrase>.

Push changes to GitHub

Push your changes using the command git push:

git push origin <a-branch-name>

replacing <a-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.

Now submit the pull request.

Soon we'll be merging all your changes into the make branch of this project. You will get a notification email once the changes have been merged.

Where to go from here?

Congrats! You've just become a Mount contributor. Celebrate your contribution by adding your icon to the main readme.md, and sharing with your friends and followers.

       

To add your icon to the readme.md, just follow what we have done to get the user avatar from GitHub and link to your profile. You can get your user ID from the GitHub API by visiting https://api.github.com/users/thehydroimpulse, but instead of thehydroimpulse, put your username.

You could also join our slack team in case you need any help or have any questions. Whatever works best.