Add contributing and style guides for documentation #1013
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
valeriahhdez
added
📝 Documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1013 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 373 373
Branches 94 94
=========================================
Hits 373 373 ☔ View full report in Codecov by Sentry. |
benjagm
requested changes
Oct 12, 2024
Thank you @benjagm! I attended your comments and changed the status of the PR |
benjagm
approved these changes
Oct 21, 2024
Integrate Benjamin's comments into style-guide.md
Include Benjamin's comments in CONTRIBUTING-docs.md
valeriahhdez
force-pushed
the
contributing-style-guides
branch
from
09addcd to
4c7d36f
Compare
|
Congratulations, @valeriahhdez for your first pull request merge in this repository! 🎉🎉. Thanks for your contribution to JSON Schema! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
This PR contains the style guide and contributing guide for documentation. The goal of this documents is to help people interested in contributing to documentation learn about our processes and text-formatting conventions for creating consistent documentation.
Issue Number:
Screenshots/videos:
If relevant, did you update the documentation?
Summary
We need a more comprehensive guide for contributing to documentation and a style guide for creating consistent documentation. This PR adds two new documents to help newcomers start contributing to docs.
Does this PR introduce a breaking change?. No