Skip to content
This repository was archived by the owner on Apr 10, 2026. It is now read-only.

Commit 5d2b196

Browse files
author
Barrie Byron
authored
Update sdk tutorials repo CONTRIBUTING.md (#732)
* Update CONTRIBUTING.md iterative improvements for our contributing, taking lessons learned from the Pylons docs kickoff https://docs.google.com/document/d/1YqyF4CVx_wEN-MPdXtW7krkhhDWdSfb8LMrSeFBZFtw/edit?usp=sharing * Update CONTRIBUTING.md
1 parent 5a1fd09 commit 5d2b196

1 file changed

Lines changed: 35 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,26 @@ Thank you for helping us to create and maintain awesome tutorials.
1414
- To provide feedback, file an issue and provide abundant details to help us understand how we can make it better.
1515
- To provide feedback and a fix, you can make a direct contribution. This repo is protected since we provide the code and the docs to help you learn. If you're not a member or maintainer, fork the repo and then submit a PR from your forked repo to master.
1616

17+
## Writing and contributing
18+
19+
We welcome contributions to the tutorials. Our technical content follows the Google developer documentation style guide:
20+
21+
- [Google developer documentation style guide](https://developers.google.com/style)
22+
- [Highlights](https://developers.google.com/style/highlights)
23+
- [Word list](https://developers.google.com/style/word-list)
24+
- [Style and tone](https://developers.google.com/style/tone)
25+
- [Writing for a global audience](https://developers.google.com/style/translation)
26+
- [Cross-references](https://developers.google.com/style/cross-references)
27+
- [Present tense](https://developers.google.com/style/tense)
28+
29+
The Google guidelines include more material than listed here, and are used as a
30+
guide that enables easy decision making about proposed content changes.
31+
32+
Other useful resources:
33+
34+
- [Google Technical Writing Courses](https://developers.google.com/tech-writing)
35+
- [GitHub Guides Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
36+
1737
## Metadata
1838

1939
The layout metadata at the top of the README.md file controls how the tutorial page is published. Write permissions are limited to preserve the structure and contents.
@@ -22,7 +42,7 @@ The layout metadata at the top of the README.md file controls how the tutorial p
2242

2343
Each Cosmos SDK tutorial lives in a self-describing folder: `blog`, `hello-world`, `voter`, and so on.
2444

25-
Two sub-folders are present for each production-ready tutorial:
45+
Two sub-folders are present for most of the production-ready tutorials:
2646

2747
- A self-describing sub-folder for the app and the rest of the code that runs the tutorial.
2848
- A `tutorial` sub-folder for the Markdown files (*.md) that build the published tutorial docs.
@@ -31,9 +51,9 @@ Work-in-process tutorials might have content and code in other repos.
3151

3252
## Who works on the tutorials?
3353

34-
- The Tendermint (All in Bits) DevX team (@fadeev, @lubtd, @ilgooz and other amazing devs that I don't know the GitHub usernames for) develops the tutorial code and dependencies. Don't they do an amazing job?
54+
- The Tendermint (All in Bits) DevX team develops the tutorial code and dependencies. Our team includes [@fadeev](https://github.com/fadeev), [@lubtd](https://github.com/lubtd), [@ilgooz](https://github.com/ilgooz), [@Pantani](https://github.com/Pantani), and other talented developers. Don't they do an amazing job?
3555

36-
- The Tendermint (All in Bits) EcoDev Engineering team (@toschdev, @lukitsbrian, @barriebyron) manages developer experience and owns the tutorial doc content.
56+
- The Tendermint (All in Bits) EcoDev Engineering team ([@toschdev](https://github.com/toschdev), [@barriebyron](https://github.com/barriebyron), [@alijnmerchant21](https://github.com/alijnmerchant21, and more incoming team members) manages the developer experience and owns the tutorial doc content.
3757

3858
- The Tendermint (All in Bits) Design team owns the front end and publishing. Be sure to check with @lovincyrus for details about the metadata for layout and publishing tutorials.
3959

@@ -58,28 +78,28 @@ Since the deploy preview doesn't work on Draft PRs, follow these steps to previe
5878

5979
1. If you haven't already, clone the tutorials repo to your local machine and change to that directory. For example:
6080

61-
```
62-
cd ~/github
63-
git clone https://github.com/cosmos/sdk-tutorials
64-
cd sdk-tutorials
65-
```
81+
```
82+
cd ~/github
83+
git clone https://github.com/cosmos/sdk-tutorials
84+
cd sdk-tutorials
85+
```
6686
6787
2. Local tutorials require JavaScript. If needed, install [npm](https://docs.npmjs.com/cli/v6/commands/npm-install).
6888
6989
3. For each branch you work in, install the npm packages for the SDK tutorials:
7090
71-
```
72-
npm install
73-
```
91+
```
92+
npm install
93+
```
7494
7595
4. Start the local instance of the tutorial build:
7696
77-
```
78-
npm run serve
79-
```
97+
```
98+
npm run serve
99+
```
80100
81101
A successful client compile looks like: `> VuePress dev server listening at http://localhost:8080/ ✔ Client Compiled successfully in 280.71ms success [12:06:28] Build 03d41f finished in 283 ms! ( http://localhost:8080/ )`
82102
83103
5. You can now view the tutorial build on a local web browser. Isn't this fun?
84104
85-
Tip: On a mac, press the command key and click `http://localhost:8080/` for quick access.
105+
Tip: On a mac, press the command key and click `http://localhost:8080/` for quick access.

0 commit comments

Comments
 (0)