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

docs: renewal docs for open source of lbm-sdk #205

Merged
merged 3 commits into from
May 25, 2021

Conversation

egonspace
Copy link

Description

It seems that document work needs to be done over a long period of time. First of all, I wrote a minimum of documents.

  • LICENSE, NOTICE
  • CHANGELOG
  • README

The following document work should be carried out later.

  • quick start
  • Release, PR Procedure

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • 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
  • Review Codecov Report in the comment section below once CI passes

@egonspace egonspace self-assigned this May 25, 2021
@egonspace egonspace requested review from zemyblue and wetcod May 25, 2021 08:58
@egonspace egonspace added this to the Initail ebony milestone May 25, 2021
@egonspace egonspace added the documentation Improvements or additions to documentation label May 25, 2021
Copy link
Contributor

@wetcod wetcod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants