-
-
Notifications
You must be signed in to change notification settings - Fork 178
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
fix: Update CONTRIBUTING-docs.md with instructions for adding metadata to markdown files #1101
base: main
Are you sure you want to change the base?
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1101 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 373 373
Branches 94 94
=========================================
Hits 373 373 ☔ View full report in Codecov by Sentry. |
@DhairyaMajmudar @kwennB please review this PR |
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.
Good work, and thank you for your quick response to this issue.
I have added some comments.
Here is the style guide to also help. https://github.com/json-schema-org/website/blob/main/pages/md-style-guide.md |
@techmannih, thanks for your hard work on improving the contribution guide! Your changes have made it clearer and more user-friendly. I do have a small issue regarding the level of detail in the steps. For straightforward tasks, providing too many steps might come across as condescending. To avoid this, we could simplify the instructions by providing a high-level overview and letting the reader fill in the details. Let me know if you have any questions. |
@kwennB please check now |
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.
Thank you for your work on this PR!
We don't add detailed step-by-step instructions for straightforward tasks, like adding metadata to a .md file. I suggest adding a general instruction and letting the reader fill in the details themselves.
@valeriahhdez Thanks for the feedback! I’ve updated the instructions to be more general as suggested. please check now |
1c3aa2b
to
c4174e7
Compare
Looking good @techmannih! I left two more comments, but after you addressed them, it will be better to merge |
@valeriahhdez |
@techmannih I tagged you in the comments I left a few minutes ago |
@valeriahhdez Which comments are still pending? I think I might have misunderstood. |
Hello @techmannih, Have you had time to go through the last review I made on this PR? |
Issue Number:
This PR updates the CONTRIBUTING-docs.md file to include instructions on adding metadata (YAML front matter) to new markdown files.
Added guidelines for including metadata fields like title, section, date, author, and tags.