Permalink
Browse files

Added a note regarding pull requests. Also updated the commands regar…

…ding running tests in the docs
  • Loading branch information...
1 parent 6f4d0e7 commit 66cf405b429674674cd984267ca58c8aadea9b32 @christeredvartsen christeredvartsen committed Nov 12, 2014
Showing with 14 additions and 2 deletions.
  1. +7 −0 CONTRIBUTING.md
  2. +7 −2 docs/develop/contributing.rst
View
@@ -1,4 +1,11 @@
# Contributing to Imbo
+
+## Resources
+
+If you wish to contribute to Imbo, please read the following resources first:
+
+* The [Contributing to Imbo](http://docs.imbo-project.org/en/latest/develop/contributing.html) chapter in the documentation
+
## Running tests
Imbo has both [Behat](http://docs.behat.org/en/v2.5/) and [PHPUnit](https://phpunit.de/) tests, and when adding new features or fixing bugs you are required to add relevant test cases. Remember to install the development requirements using [Composer](https://getcomposer.org/) before running the tests:
@@ -38,7 +38,7 @@ When introducing new features you are required to add tests. Unit/integration te
.. code-block:: console
- ./vendor/bin/phpunit -c tests
+ ./vendor/bin/phpunit -c tests/phpunit
If you want to generate code coverage as well you can run the test suite by using a Rake task:
@@ -50,7 +50,7 @@ For the Behat test suite you can run similar commands:
.. code-block:: console
- ./vendor/bin/behat --profile travis
+ ./vendor/bin/behat --strict --profile no-cc --config tests/behat/behat.yml
to skip code coverage, or
@@ -84,3 +84,8 @@ End user documentation (the ones you are reading now) is written using `Sphinx <
rake readthedocs
This task also includes a spell checking stage.
+
+Pull requests on GitHub
++++++++++++++++++++++++
+
+If you want to send a pull request, please do so from a publicly available fork of Imbo, using a feature branch with a self descriptive name. The pull request should be sent to the ``develop`` branch. If your pull request is fixing an open issue from `the issue tracker <https://github.com/imbo/imbo/issues>`_ your branch can be named after the issue number, for instance ``issue-312``.

0 comments on commit 66cf405

Please sign in to comment.