diff --git a/Documentation/source/development.rst b/Documentation/source/development.rst new file mode 100644 index 0000000..0913928 --- /dev/null +++ b/Documentation/source/development.rst @@ -0,0 +1,29 @@ +.. _contribution: + +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. + +.. _contribution_development: + +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 :ref:`concepts`. + +.. _Github: https://github.com/DanielSiepmann/search_core +.. _travis-ci: https://travis-ci.org/ +.. _PSR-2: http://www.php-fig.org/psr/psr-2/ diff --git a/Documentation/source/index.rst b/Documentation/source/index.rst index 5352092..dfda13b 100644 --- a/Documentation/source/index.rst +++ b/Documentation/source/index.rst @@ -13,3 +13,4 @@ Table of Contents concepts connections indexer + development diff --git a/Documentation/source/usage.rst b/Documentation/source/usage.rst index 0c1ea95..1fc0e51 100644 --- a/Documentation/source/usage.rst +++ b/Documentation/source/usage.rst @@ -29,3 +29,11 @@ The tables have to be white listed through :ref:`allowedTables` option. .. note:: Not all hook operations are supported yet, see :issue:`27`. + +.. _usage_searching: + +Searching / Frontend Plugin +--------------------------- + +To provide a search interface you can insert the frontend Plugin as normal content element of type +plugin. The plugin is named *Search Core*.