Skip to content
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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

techmannih
Copy link
Contributor

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.

@techmannih techmannih requested a review from a team as a code owner November 9, 2024 16:23
Copy link

github-actions bot commented Nov 9, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview c4174e7

Copy link

codecov bot commented Nov 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9899bc7) to head (c4174e7).

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.
📢 Have feedback on the report? Share it here.

@techmannih
Copy link
Contributor Author

@DhairyaMajmudar @kwennB please review this PR

Copy link
Contributor

@kwennB kwennB left a 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.

CONTRIBUTING-docs.md Outdated Show resolved Hide resolved
CONTRIBUTING-docs.md Outdated Show resolved Hide resolved
CONTRIBUTING-docs.md Outdated Show resolved Hide resolved
@kwennB
Copy link
Contributor

kwennB commented Nov 14, 2024

Here is the style guide to also help. https://github.com/json-schema-org/website/blob/main/pages/md-style-guide.md

@valeriahhdez
Copy link
Contributor

@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.

@techmannih
Copy link
Contributor Author

@kwennB please check now

Copy link
Contributor

@valeriahhdez valeriahhdez left a 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.

CONTRIBUTING-docs.md Outdated Show resolved Hide resolved
CONTRIBUTING-docs.md Outdated Show resolved Hide resolved
@techmannih
Copy link
Contributor Author

@valeriahhdez Thanks for the feedback!

I’ve updated the instructions to be more general as suggested. please check now

@valeriahhdez
Copy link
Contributor

Looking good @techmannih!

I left two more comments, but after you addressed them, it will be better to merge

@techmannih
Copy link
Contributor Author

@valeriahhdez
Which comments are still pending? I believe these have already been updated. Could you please revise them again

@valeriahhdez
Copy link
Contributor

@valeriahhdez Which comments are still pending? I believe these have already been updated. Could you please revise them again

@techmannih I tagged you in the comments I left a few minutes ago

@techmannih
Copy link
Contributor Author

Looking good @techmannih!

I left two more comments, but after you addressed them, it will be better to merge

@valeriahhdez Which comments are still pending? I think I might have misunderstood.

@valeriahhdez
Copy link
Contributor

valeriahhdez commented Nov 28, 2024

Hello @techmannih,

Have you had time to go through the last review I made on this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Update docs contributing guide: "Add meta-data to newly created markdown file".
3 participants