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

docs: adding documentation writing guidelines #9366

Merged
merged 7 commits into from
May 25, 2021
Merged

Conversation

robert-zaremba
Copy link
Collaborator

@robert-zaremba robert-zaremba commented May 19, 2021

Description

Was hanging for a long time and emerged during extraordinary documentation reviews by @barriebyron .

It's not complete but at least it provides a good base with links to the resources we should use.

closes: #8906


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@robert-zaremba robert-zaremba added the T:Docs Changes and features related to documentation. label May 19, 2021
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@blushi blushi left a comment

Choose a reason for hiding this comment

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

pre-approving

CONTRIBUTING.md Outdated Show resolved Hide resolved
@tac0turtle tac0turtle requested a review from barriebyron May 20, 2021 10:12
Copy link
Contributor

@ryanchristo ryanchristo left a comment

Choose a reason for hiding this comment

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

Looks like a good start.

docs/DOC_WRITING_GUIDELINES.md Outdated Show resolved Hide resolved
docs/DOC_WRITING_GUIDELINES.md Outdated Show resolved Hide resolved
docs/DOC_WRITING_GUIDELINES.md Outdated Show resolved Hide resolved
docs/DOC_WRITING_GUIDELINES.md Outdated Show resolved Hide resolved
docs/DOC_WRITING_GUIDELINES.md Outdated Show resolved Hide resolved
docs/DOC_WRITING_GUIDELINES.md Outdated Show resolved Hide resolved
Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Ryan Christoffersen <[email protected]>
@robert-zaremba robert-zaremba added the A:automerge Automatically merge PR once all prerequisites pass. label May 25, 2021
mergify bot pushed a commit that referenced this pull request May 25, 2021
* docs: adding documentation writing guidelines

* update

* Apply suggestions from code review

Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Ryan Christoffersen <[email protected]>

Co-authored-by: likhita-809 <[email protected]>
Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Ryan Christoffersen <[email protected]>
@github-actions github-actions bot removed the T:Docs Changes and features related to documentation. label May 25, 2021
@mergify mergify bot merged commit 61bd6cb into master May 25, 2021
@mergify mergify bot deleted the robert/doc-guidelines branch May 25, 2021 15:15
@barriebyron
Copy link
Contributor

let this one fall off my radar, thanks for doing this work @robert-zaremba

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add links to technical guidence.
5 participants