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

Contributing guide #851

Closed
wants to merge 7 commits into from
Closed

Contributing guide #851

wants to merge 7 commits into from

Conversation

valeriahhdez
Copy link
Contributor

What kind of change does this PR introduce?

This PR adds a Contributing guide for the JSON Schema documentation.

Issue #830

Screenshots/videos:

If relevant, did you update the documentation?

Summary

This PR explains the workflows and expectations when contributing to documentation, making it easier for technical writers to find their way in the JSON Schema project.

Does this PR introduce a breaking change? No, it doesn't

@valeriahhdez valeriahhdez added 📝 Documentation Indicates improvements or additions to documentation. GSoD Google Season of Docs labels Aug 7, 2024
@valeriahhdez valeriahhdez requested review from benjagm and kwennB August 7, 2024 02:22
@valeriahhdez valeriahhdez self-assigned this Aug 7, 2024
Copy link

github-actions bot commented Aug 7, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

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

Copy link

codecov bot commented Aug 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@753017b). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff            @@
##             main      #851   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         1           
  Lines           ?        20           
  Branches        ?        12           
========================================
  Hits            ?        20           
  Misses          ?         0           
  Partials        ?         0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@benjagm
Copy link
Collaborator

benjagm commented Aug 13, 2024

Hi Valeria I see in this PR content who belongs to multiple issues, like #790 and that is not ideal. You should work in different branches submitting changes separated from each other.

Specifically, for contributing to the JSON Schema docs I am expecting the changes to be included as part of the existing contributing guide. Later we can work on using a symlink to show that markdown file as a page (As we do with sponsors and the code of conduct md files. I can help to implement this ).

The contributing information we show in the website should cover all the possible contribution paths and not only the docs.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some comments here:

#851 (comment)

@benjagm benjagm added the Status: In Progress This issue is being worked on, and has someone assigned. label Aug 13, 2024
@valeriahhdez valeriahhdez deleted the contributing-guide branch August 25, 2024 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. GSoD Google Season of Docs Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Update improving documentation section of contributing guide
3 participants