MemoRekallMember web app

This project has been created to help artists document their creative process with video notes and documents.

Contributors

The Tetras Libre team follows some code quality requirements. Indeed, to ensure the respect of the standards PHP and JavaScript rules, we use a pre-commit hook as a safety net before sending any contribution. The following quality tool scripts will be triggered before reaching commit message editor.

• PHPUnit (functional and unit tests)
• PHP_CodeSniffer (for PSR standards)
• PHPSTAN (for static analysis)
• ESLint (JavaScript linter)

How to run the code quality scripts?

First, you need to enter the memorekall-member docker container: docker-compose exec memorekall-member bash

• To run the script independently of a commit: composer {phpcs/phpstan/tests} or npm install and npm run lint for ESLint
• To fix PHP_CodeSniffer errors: composer phpcbf
• To run them all: composer ci

How to contribute to the MemoRekall project?

Please configure your local git as follows:

1. From your terminal, run: git global core.hooksPath ./tools/git-hooks/
2. Make the pre-commit hook executable running: sudo chmod +x ./tools/git-hooks/pre-commit