Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 1.95 KB

CONTRIBUTION.md

File metadata and controls

76 lines (50 loc) · 1.95 KB
Raw

LaraStrict contribution

Feel free to contribute. Guide lines contributions:

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)

Commit messages

  • We are using conventionalcommits
  • CHANGELOG.md is generated from given commits using this action.
  • Use: fix: feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:
  • These keywords will ignore changelog change build,docs,style

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.

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

Clone Larastrict repository in our project and use it

  1. git submodule add git@github.com:wrk-flow/larastrict.git core
  2. Add this to your composer.json and repositories key.
{
  "type": "path",
  "url": "./core"
}
  1. composer require wrkflow/larastrict:*
  2. (optional, IDEA) Mark core/src directory as Sources root and set Larastrict as the namespace.

Stubfiles

For MakeExpectationCommand we are using stubs. If you want to generate the stub files from current command output then run:

  • Composer: composer test:stubs
  • PHPStorm run configuration: test:stubs

Fixes

  • nikic/php-parser - on v4.13.0 enum with value named Array fails to be parsed, v4.14.0 works