From f3c3d9ee3302f7913b8487c890c5b2e4ace99ef1 Mon Sep 17 00:00:00 2001
From: Jan Pecha <janpecha@email.cz>
Date: Sun, 7 Oct 2018 11:50:46 +0200
Subject: [PATCH] Added contributing.md

---
 .gitattributes  |  1 +
 contributing.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 contributing.md

diff --git a/.gitattributes b/.gitattributes
index d5e4ceb..9fef706 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,5 +1,6 @@
 .gitattributes export-ignore
 .gitignore export-ignore
 .travis.yml export-ignore
+contributing.md export-ignore
 tests/ export-ignore
 tools/ export-ignore
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 0000000..b5dd9e8
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,58 @@
+# How to contribute
+
+There are several ways to help out:
+
+* Create an issue on GitHub, if you have found a bug
+* Write test cases for open bug issues
+* Write fixes for open bug/feature issues, preferably with test cases included
+* Contribute to the [documentation](https://github.com/LeanMapper/LeanMapper.github.io) or [examples](https://github.com/LeanMapper/examples)
+
+
+## Issues
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report.
+
+**Feature requests** are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature.
+
+
+## Contributing
+
+### Preparing environment
+
+Start with [forking](https://help.github.com/articles/fork-a-repo) [Lean Mapper on GitHub](https://github.com/Tharos/LeanMapper).
+Carefully [set up](https://help.github.com/articles/set-up-git) your local Git environment, configure your username and email, these credentials will identify your changes in Lean Mapper history.
+
+
+### Working on your patch
+
+Before you start working on your patch, create a new branch for your changes.
+
+```
+git checkout -b new_branch_name
+```
+
+
+### Testing your changes
+
+You need to install [Nette Tester](https://tester.nette.org/). The easiest way is to call `composer install` in repository root.
+
+Now you should be able to run tests. On unix-like systems run following command in your terminal:
+
+```
+vendor/bin/tester -p php -c tests/php-unix.ini
+```
+
+**Note:** the tests require these PHP extensions:
+
+* `json`
+* `sqlite3`
+* `tokenizer`
+
+----
+
+Please do not fix whitespace, format code, or make a purely cosmetic patch.
+
+Thanks!