Work-Related/search_core
Work-Related/search_core
1
0
mirror of https://github.com/Codappix/search_core.git synced 2024-11-23 02:56:12 +01:00
Code Releases Activity
search_core/Documentation/development/contribution.rst
Daniel Siepmann 839a9a954a
Improve documentation 
* Update some parts regarding current state.

Relates: #176
2019-06-06 17:19:49 +02:00

1.6 KiB
Raw Blame History

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 your environment matches the following requirements:

  • composer is executable
  • PHP on CLI is executable
  • MySQL is up and running with user dev and password dev on 127.0.0.1 or to overwrite the environment variables, see Makefile. And MySQL is not set to strict mode as TYPO3 doesn't support strict mode, see https://review.typo3.org/#/c/26725/3/INSTALL.md.
  • Elasticsearch is installed and up and running on localhost:9200.

Then setup your system:

git clone git@github.com:codappix/search_core.git \
    && cd search_core \
    && export typo3DatabaseName="searchcoretest" \
    && make install \
    && make unitTests \
    && make functionalTests \
    && make cgl

If all tests are okay, start your work.

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 useful.
  • Code has to follow PSR-2.
  • Adjusted documentation.
  • Make sure to follow the documented concepts.