Improve library user documentation #2254
ci.yml
on: pull_request
Matrix: test
Lint Commit Messages
59s
lint
15s
Build Package
8s
Test Semantic Release
1m 1s
release
0s
Annotations
1 error
|
Lint Commit Messages
You have commit messages with errors
⧗ input: Improve library user documentation
Update the documentation to answer basic questions from a first time library user perspective. Given the deeper submodules, it may be harder to find so we add details so users can understand the bigger picture.
Some existing documentation was focused more on design details for deeper implementation issues, so this clarifies what is lower level vs higher level.
✖ subject may not be empty [subject-empty]
✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
|