yamp/CONTRIBUTING.md

Yet Another Markdown Parser

# CONTRIBUTING
_We love pull requests from everyone._

To contribute to **yamp** you can clone the official repository <https://github.com/angrykoala/yamp> or your own _fork_ with `git`.

You can also download it from [GitHub](https://github.com) clicking [here](https://github.com/angrykoala/yamp/archive/master.zip).

If you want to report an error or improvement, you can open an [issue](https://github.com/angrykoala/yamp/issues), please make sure the issue is not already reported. 

If you want to contribute to yamp please:

1. Check the opened and closed issues before creating one
2. Fork from https://github.com/angrykoala/yamp/, then clone your repo
3. Make your changes. Add unit tests for your changes.
4. Make sure all tests pass before making a pull request
5. Use `dev` branch as base branch for your PR
6. Push to your fork and [submit a pull request][pr]

[pr]: https://github.com/angrykoala/yamp/compare/

At this point while you're waiting for your pull request to be accepted we may suggest some changes or improvements
or alternatives.

Some things that will increase the chance that your pull request is accepted:

* Write readable code.
* Write tests.
* Write good commit messages.
* Add the issue number in your commit.

Thanks for your help!

>YAMP is developed under GNU GPL-3 license by @angrykoala