New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: refactor lib/module document #136
Conversation
crate / module documentation move to pure Markdown crate documentation move to lib.md module documentation move to [module_dir]/module.md
Codecov Report
@@ Coverage Diff @@
## main #136 +/- ##
==========================================
+ Coverage 87.80% 87.82% +0.01%
==========================================
Files 203 203
Lines 12620 12620
==========================================
+ Hits 11081 11083 +2
+ Misses 1539 1537 -2
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like to use include_str!
but have some requests.
sorry, I mistakenly made it ready (so made it back to draft again). |
suppress MD041 markdown lint warning
add suppress markdown lint MD024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
## [Unreleased] | ||
|
||
### Changed | ||
|
||
- Refactor : crate/module document move to pure Markdown ([#136](https://github.com/SpringQL/SpringQL/pull/136)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nits] I interpreted from "keep a changelog" and semantic versioning that Changed
sections include "breaking changes", which bump up major versions.
But "keep a changelog" is a human readable format (not a machine readable one) and you noted Refactor:
, it should be OK to add this line in CHANGELOG.
Issue number and link
Related Issue: #105
Describe your changes
crate / module documentation move to pure Markdown
crate documentation move to lib.md
module documentation move to [module_dir]/module.md
Checklist before requesting a review
## [Unreleased]
section inCHANGELOG.md
following keep a changelog syntax (bugfix/feature)