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
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ If you open a PR on the Cosmos SDK, it is mandatory to update the relevant docum
- If your changes relate to the core of the CLI or Light-client (not specifically to module's CLI/Rest), please modify the `docs/interfaces/` folder.
- If your changes relate to a module, please update the module's spec in `x/moduleName/docs/spec/`.

When writing a documentation, follow the [Documentation Writing Guidelines](./docs/DOC_WRITING_GUIDELINES.md).
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved

## Forking

Please note that Go requires code to live under absolute paths, which complicates forking.
Expand Down Expand Up @@ -166,7 +168,7 @@ For example, in vscode your `.vscode/settings.json` should look like:

## Testing

Tests can be ran by running `make test` at the top level of the SDK repository.
Tests can be ran by running `make test` at the top level of the SDK repository.

We expect tests to use `require` or `assert` rather than `t.Skip` or `t.Fail`,
unless there is a reason to do otherwise.
Expand Down Expand Up @@ -204,7 +206,7 @@ The SDK utilizes [semantic versioning](https://semver.org/).
Ensure that you base and target your PR on the `master` branch.

All feature additions should be targeted against `master`. Bug fixes for an outstanding release candidate
should be targeted against the release candidate branch.
should be targeted against the release candidate branch.

### Development Procedure

Expand Down Expand Up @@ -324,7 +326,7 @@ the community of this project.
## Concept & Release Approval Process

The process for how Cosmos SDK maintainers take features and ADRs from concept to release
is broken up into three distinct stages: **Strategy Discovery**, **Concept Approval**, and
is broken up into three distinct stages: **Strategy Discovery**, **Concept Approval**, and
**Implementation & Release Approval**


Expand Down Expand Up @@ -352,7 +354,7 @@ If an individual Pull Request for an ADR needs more time than 2 weeks to reach r
in current state (`Draft` or `Proposed`), with its contents updated to summarize
the current state of its discussion.

If an ADR is taking longer than 4 weeks to reach a final conclusion, the **Concept Approval Committee**
If an ADR is taking longer than 4 weeks to reach a final conclusion, the **Concept Approval Committee**
should convene to rectify the situation by either:
- unanimously setting a new time bound period for this ADR
- making changes to the Concept Approval Process (as outlined here)
Expand Down Expand Up @@ -396,7 +398,7 @@ well as for PRs made as part of a release process:
* Code reviewers should ensure the PR does exactly what the ADR said it should
* Code reviewers should have more senior engineering capability
* 1/2 approval is required from the **primary repo maintainers** in `CODEOWNERS`

*Note: For any major or minor release series denoted as a "Stable Release" (e.g. v0.39 "Launchpad"), a separate release
committee is often established. Stable Releases, and their corresponding release committees are documented
separately in [STABLE_RELEASES.md](./STABLE_RELEASES.md)*
16 changes: 16 additions & 0 deletions docs/DOC_WRITING_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Documentation Writing Guidelines

## Best practices
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved

+ Check the spelling and grammar, even if you have to copy and paste from external source.
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved
+ Use simple sentences. Easy-to-read sentences mean the reader can quickly use the guidance you share.
+ Try to express your thoughts in a concise and clean way.
+ Don't abuse `code` format when talking in plain English.
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved
+ Follow Google developer documentation style [guide](https://developers.google.com/style).
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved
+ Check the meaning of the words in Microsoft a-z word list term [collections](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/above) (use the search input!).
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved



## Technical writing course
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved

Google provides a free [course](https://developers.google.com/tech-writing/overview) for technical writing.