Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 1.76 KB

contributing.md

File metadata and controls

64 lines (38 loc) · 1.76 KB
Raw

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 or 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 Lean Mapper on GitHub. Carefully set up 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. 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 -C tests

or use Composer script:

composer tests

Note: the tests require these PHP extensions:

  • json
  • sqlite3
  • tokenizer

Please do not fix whitespace, format code, or make a purely cosmetic patch.

Thanks!