You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 10, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+35-15Lines changed: 35 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,26 @@ Thank you for helping us to create and maintain awesome tutorials.
14
14
- To provide feedback, file an issue and provide abundant details to help us understand how we can make it better.
15
15
- 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.
16
16
17
+
## Writing and contributing
18
+
19
+
We welcome contributions to the tutorials. Our technical content follows the Google developer documentation style guide:
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
22
42
23
43
Each Cosmos SDK tutorial lives in a self-describing folder: `blog`, `hello-world`, `voter`, and so on.
24
44
25
-
Two sub-folders are present for each production-ready tutorial:
45
+
Two sub-folders are present for most of the production-ready tutorials:
26
46
27
47
- A self-describing sub-folder for the app and the rest of the code that runs the tutorial.
28
48
- 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.
31
51
32
52
## Who works on the tutorials?
33
53
34
-
- The Tendermint (All in Bits) DevX team (@fadeev, @lubtd, @ilgoozand 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?
35
55
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.
37
57
38
58
- 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.
39
59
@@ -58,28 +78,28 @@ Since the deploy preview doesn't work on Draft PRs, follow these steps to previe
58
78
59
79
1. If you haven't already, clone the tutorials repo to your local machine and change to that directory. For example:
60
80
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
+
```
66
86
67
87
2. Local tutorials require JavaScript. If needed, install [npm](https://docs.npmjs.com/cli/v6/commands/npm-install).
68
88
69
89
3. For each branch you work in, install the npm packages for the SDK tutorials:
70
90
71
-
```
72
-
npm install
73
-
```
91
+
```
92
+
npm install
93
+
```
74
94
75
95
4. Start the local instance of the tutorial build:
76
96
77
-
```
78
-
npm run serve
79
-
```
97
+
```
98
+
npm run serve
99
+
```
80
100
81
101
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/ )`
82
102
83
103
5. You can now view the tutorial build on a local web browser. Isn't this fun?
84
104
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