Skip to content

Enforce Coding Conventions with linting GitHub Actions #36

@official-sounding

Description

@official-sounding

As more developers are starting to contribute to the project, I would suggest enforcing code style and quality standards using a GitHub Actions-based check on PRs. It would prevent merging if the changes do not pass the linter. There is a pre-spun action for Laravel Pint that should make this easy for the PHP code.

IT may be necessary to also introduce something like ESLint to lint various front-end assets like js/css/html (or maybe Pint can do this, I'm not sure)

There is maybe also an opportunity to use something like husky-php to add git hooks to push lint checks as close to developers as possible, running Pint as a part of a commit hook will make it annoying for developers to commit poorly formatted code.

Another option would be expanding the .editorconfig file - most editors will take the contents of this file when applying post-save formatting, which is nice for things like tabs-vs-spaces (and tab depth) and other hard-to-spot-during-review style stuff.

Metadata

Metadata

Assignees

No one assigned

    Labels

    collaborationDeveloper environment and/or encouraging additional dev supportuser experiencePosting and comment workflows, user profile options, etc

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions