certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs
History
Robert Zaremba f7f1b86506
docs: adding acceptance tests description (#10534) 
## Description

We start to adopt acceptance tests when designing new module. We had few internal sessions on how to do and started to practice it. 
We should better document the process and start requiring it with new documents. 

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
 		2021-12-10 01:34:34 +00:00
..
.vuepress remove top banner (#10530) 2021-11-12 14:19:24 +01:00
architecture docs(adr): Update ADR-045 with new middleware interface (#10693) 2021-12-08 09:43:31 +00:00
assets docs: adding acceptance tests description (#10534) 2021-12-10 01:34:34 +00:00
basics chore: Minor typos and edits (#10628) 2021-11-28 00:02:57 +00:00
building-modules Minor doc fixes (#10537) 2021-11-14 21:48:53 +01:00
core refactor: middleware refactor to change tx.Handler interface (#10527) 2021-12-02 06:54:38 +00:00
ibc docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
intro fix: link text Cosmos SDK (#10641) 2021-11-30 11:13:11 +01:00
ko docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
migrations style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
ru style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
run-node style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
spec docs: adding acceptance tests description (#10534) 2021-12-10 01:34:34 +00:00
uml docs: uml hotfix (#9124) 2021-04-16 07:59:21 +00:00
using-the-sdk docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
zh docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
404.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
DOCS_README.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
DOC_WRITING_GUIDELINES.md docs: use RFC 2119 keywords (#9532) 2021-06-22 00:04:55 +00:00
README.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
cosmos-sdk-image.jpg Merge PR #4643: Update cosmos sdk image, remove unused images 2019-06-30 16:29:05 -04:00
package-lock.json docs: client docs for upgrade module (#10320) 2021-10-12 11:56:40 +00:00
package.json bump vuepress-theme-cosmos (#9099) 2021-04-13 12:18:47 +00:00
post.sh docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
pre.sh docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
protodoc-markdown.tmpl Add script to generate proto-docs (#8238) 2020-12-31 16:10:13 +00:00
versions docs: update to v0.44 version tag (#10069) 2021-09-08 08:34:54 -07:00

README.md

Cosmos SDK Documentation

Get Started

  • Cosmos SDK Intro: High-level overview of the Cosmos SDK.
  • Starport: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain.
  • SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic Cosmos SDK principles in the process.

Reference Docs

  • Basics: Basic concepts of the Cosmos SDK, including the standard anatomy of an application, the transaction lifecycle, and accounts management.
  • Core: Core concepts of the Cosmos SDK, including baseapp, the store, or the server.
  • Building Modules: Important concepts for module developers like message, keeper, and querier.
  • IBC: IBC protocol integration and concepts.
  • Running a Node, API, CLI: How to run a node and interact with the node using the CLI and the API.
  • Migrations: Migration guides for updating to newer versions of Cosmos SDK.

Other Resources

Cosmos Hub

The Cosmos Hub (gaia) docs have moved to github.com/cosmos/gaia.

Languages

The Cosmos SDK is written in Golang, though the framework could be implemented similarly in other languages. Contact us for information about funding an implementation in another language.

Contribute

See the DOCS_README.md for details of the build process and considerations when making changes.