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

Add quick start guide #5517

Merged
merged 11 commits into from
Jan 17, 2020
Merged

Add quick start guide #5517

merged 11 commits into from
Jan 17, 2020

Conversation

gamarin2
Copy link
Contributor

Closes: #XXX

Description

Quick start guide using the latest scaffold tool


For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

For admin use:

  • Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
  • Reviewers assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@tac0turtle
Copy link
Member

nicely written, but if we break or update the scaffold tool then we have to come here and update the docs. Maybe before this gets merged we put something in the readme of that repo to fix these docs when changing things

@gamarin2
Copy link
Contributor Author

nicely written, but if we break or update the scaffold tool then we have to come here and update the docs. Maybe before this gets merged we put something in the readme of that repo to fix these docs when changing things

I think we should, because the scaffold guide will not only be used in the SDK docs, but also in the tutorials and maybe in other places. So definitely adding a list of content to update in the README of the scaffold repo is a good idea

@fedekunze fedekunze added T:Docs Changes and features related to documentation. R4R labels Jan 14, 2020
@fedekunze fedekunze changed the title [DOCS] Add quick start guide Add quick start guide Jan 14, 2020
@codecov
Copy link

codecov bot commented Jan 17, 2020

Codecov Report

Merging #5517 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5517      +/-   ##
==========================================
- Coverage   54.22%   54.21%   -0.02%     
==========================================
  Files         313      313              
  Lines       18974    18974              
==========================================
- Hits        10289    10287       -2     
- Misses       7885     7887       +2     
  Partials      800      800
Impacted Files Coverage Δ
x/mock/app.go 62.83% <0%> (-1.36%) ⬇️

@fedekunze fedekunze merged commit 13464f2 into master Jan 17, 2020
@fedekunze fedekunze deleted the gamarin/quick-start-guide branch January 17, 2020 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants