search_core/Documentation/source/development.rst
Daniel Siepmann 5989b65ae0
FEATURE: Split configuration to support the concepts
* Add a further level in configurations to support multiple connections
  and indexer.

Relates: #31
2016-12-20 10:04:44 +01:00

1.1 KiB

Contribution

Everyone is welcome to contribute, whether it's code, issues, feature requests or any other kind.

Below is a documentation what to respect during contributions.

Setup

To start contributions regarding code, make sure to setup your system:

git clone git@github.com:DanielSiepmann/search_core.git \
    && cd search_core \
    && make install \
    && make functionalTests

If all tests are okay, start your work.

Of course you might need some requirements like running elasticsearch and composer to work before.

Development

All changes are introduced through pull requests at Github and should contain the following:

  • Adjusted tests if tests existed before. Otherwise they will break on travis-ci.
  • New tests whenever possible and usefull.
  • Code has to follow PSR-2.
  • Adjusted documentation.
  • Make sure to follow the documented concepts.