Improve library user documentation (#685) #2260
ci.yml
on: push
Matrix: test
Lint Commit Messages
16s
lint
19s
Build Package
0s
Test Semantic Release
0s
release
Annotations
3 errors
|
Lint Commit Messages
You have commit messages with errors
⧗ input: Improve library user documentation (#685)
* chore: 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.
* chore: fix typo in README.md
✖ 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
|
|
test (3.14)
Process completed with exit code 3.
|
|
test (3.11)
Process completed with exit code 1.
|