Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
feat: add support for git submodules #469
Implements build-in support for linting the commits of git sub modules, which currently doesn't work because sub modules don't have their own
I updated the read module to determine if it is running from a git sub module or not and find the
Comments on my implementation are welcome, I'm happy to change it if needed
Motivation and Context
This change is required in order to support linting the commits of git sub modules.
How Has This Been Tested?
Tests are missing from this PR (at least for now) as it requires an update to the @commitlint/test package (support for sub modules in the
The reason I opened this PR first is because I wanted to be sure this would be included before updating the @commitlint/test code and adding something that wasn't really needed...
Types of changes
I'm unsure what you mean @marionebl, in the PR description I outlined how it has been tested. If you need more detail, the test scenario I added is "get edit commit message from git submodule" which requires the function submodule in @commitlint/test.
What the test scenario does in plain English is:
Does that help?