Adhere to github flavoured markdown syntax #695
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Documentation
PR Summary: This pull request focuses on updating the project's documentation to adhere to Github flavored markdown syntax. It includes changes to the README.md and CODE_OF_CONDUCT.md files, among others, to improve readability and consistency across markdown files. The changes involve formatting adjustments, such as modifying header levels and updating links to use markdown syntax instead of HTML. Additionally, the PR introduces a pre-commit hook using mdformat with a plugin for Github flavored markdown to ensure future contributions maintain these standards.
Decision: Comment
📝 Type: 'Documentation' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
- Unsupported files: the diff contains files that Sourcery does not currently support during reviews.
- Big diff: the diff is too large to approve with confidence.
General suggestions:
- Ensure that all placeholders like '[INSERT EMAIL ADDRESS]' in documentation are replaced with actual, relevant information to avoid confusion and ensure clarity.
- Consider reviewing all documentation changes to ensure they not only adhere to markdown syntax but also maintain the intended meaning and readability.
- It might be beneficial to include a brief section or note in the CONTRIBUTING.md about the introduction of the
mdformatpre-commit hook, guiding contributors on how to set up their environment to comply with these formatting standards.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
| @@ -56,7 +55,7 @@ a project may be further defined and clarified by project maintainers. | |||
| ## Enforcement | |||
|
|
|||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | |||
| reported by contacting the project team at [INSERT EMAIL ADDRESS]. All | |||
| reported by contacting the project team at \[INSERT EMAIL ADDRESS\]. All | |||
There was a problem hiding this comment.
issue (llm): The placeholder '[INSERT EMAIL ADDRESS]' should be replaced with an actual contact email for reporting unacceptable behavior. This is crucial for enforcing the code of conduct.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #695 +/- ##
=======================================
Coverage 43.97% 43.97%
=======================================
Files 13 13
Lines 332 332
=======================================
Hits 146 146
Misses 186 186 ☔ View full report in Codecov by Sentry. |
|
Hey, Thanks for the PR! Do you mind resolving the conflicts? I think this change should be fine. Thanks for the contribution! 🙏 |
tinvaan
force-pushed
the
studio/markdown
branch
from
4f67743
to
5434df7
Compare
|
@J0 done 👍🏼 Thanks for looking into this ❤️ |
|
Really sorry @tinvaan, could you run the pre-commit hook on the codebase again? Think the CHANGELOG.md resolution I made doesn't conform to linter requirements. Feel free to merge once the tests pass |
Changes generated by: mdformat-gfm
tinvaan
force-pushed
the
studio/markdown
branch
from
eb98fde
to
5a7d412
Compare
What kind of change does this PR introduce?
Minor docs update - fixes several linter errors/warnings for markdown files and conforms to Github flavoured markdown syntax.
Changes are auto-generated using
mdformat's github flavoured markdown plugin and also included as a pre-commit hook.Closes #698