Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
34 lines (21 sloc) 1.45 KB

Contributing Guidelines

Recipes are not entire tutorials -- they are small patterns that may be extracted from tutorials. The purpose of Substrate Cookbook is to identify best practices in Substrate runtime code and extract patterns that are useful outside of the context of the specific use case.

  1. isolate specific pattern
  2. walk through logic in piecewise steps
  3. show/link to the full file in the used codebase

If you want to get involved, feel free to open an issue with any ideas/comments/questions.The markdown for each recipe can be found by following the paths set in SUMMARY.md.

I'm going to spend more time working on samples over the next few weeks, but I'm in the process of improving this project as well.

Common Etiquette

  • try to not use "we" or "our" because it often is conducive to unnecessary language
  • frequently link to outside content ie original code, blog/tutorial references, documentation for a specific method/trait/etc

Local Build Instructions

Stage locally before making a PR. Don't forget to switch to a new branch before you make edits.

  1. install mdbook
$ cargo install mdbook
  1. build and open rendered book in default browser
$ mdbook build --open
  1. If everything looks good, open a Pull Request
You can’t perform that action at this time.