Contributions

Feel free to contribute. When contributing try to match this category:

Bug fixes

For bug fixes create and issue and pull request if possible.

Ideas

Use the discussion functionality and propose your idea:

• What you want to solve?
• Sample proof of concept code? (just how it could look)

Wait to take in account

• Always design your classes with dependency injection in mind (possibly constructor).
• Always think about tests -> how they should be written and if it is easy.

Checklist

• Run composer run check.
• Write PHPUnit tests.
• Update the documentation.

Lint and tests

composer run check

We are using set of tools to ensure that the code is consistent. Run this before pushing your code changes.

PHPStan

composer run check

Rector

composer run check

Easy coding standard

composer run check

Contributors

Check our contributors on GitHub

Updating documentation

We are using Nuxtjs and every new addition should be documented. It's easy:

1. Go to docs folder

   npm install
   

2. Start the dev server and open localhost:3000

   npm run dev
   

3. Docs content is located at content/en/ and written in Markdown.

4. When creating new pages you need to set position. To fix navigation and correct position per folder we are using position + X0 where X is the position of the folder.