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.

Sign up for GitHub

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

Jump to bottom

[Core] Improve module creation documentation #509

Closed
6 tasks
deblasis opened this issue Feb 14, 2023 · 2 comments · Fixed by #623
Closed
6 tasks

[Core] Improve module creation documentation #509

deblasis opened this issue Feb 14, 2023 · 2 comments · Fixed by #623
Assignees
@deblasis
Labels
core Core infrastructure - protocol related documentation Improvements or additions to documentation
Milestone
M1: Pocket PoS (P...

Comments

@deblasis
Copy link
Contributor

deblasis commented Feb 14, 2023 •
edited
Loading

Objective

Improve documentation to help new contributors better understand the patterns being used in module creation.

Origin Document

The issue stems from the this code-review comment:

Screenshot 2023-02-14 at 12 46 46 PM

Goals

  • Add godoc comments to the various interfaces, functions, methods involved in the module creation process
  • Create a new document/extend the existing ones with examples
  • Clarify also how the logging should be set-up (particularly how/where to initialize the module logger)

Deliverable

  • Updated codebase with godoc comments
  • Updated documentation README

Non-goals / Non-deliverables

  • Changes in logic
  • Refactoring module related code

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • Update any relevant local/global README(s)
  • Update relevant source code tree explanations
  • Add or update any relevant or supporting mermaid diagrams

Creator: @deblasis
Co-Owners: @Olshansk
@deblasis deblasis added documentation Improvements or additions to documentation core Core infrastructure - protocol related labels Feb 14, 2023
@deblasis deblasis self-assigned this Feb 14, 2023
@deblasis
Copy link
Contributor Author

Once this is done, it would be nice to have direct feedback from @h5law and @bryanchriswhite :)

@deblasis
Copy link
Contributor Author

cc @jessicadaugherty

@Olshansk Olshansk moved this to Backlog in V1 Dashboard Feb 14, 2023
@Olshansk Olshansk mentioned this issue Feb 14, 2023
Closed
16 tasks
@bryanchriswhite bryanchriswhite mentioned this issue Mar 1, 2023
Merged
16 tasks
@deblasis deblasis mentioned this issue Mar 27, 2023
Merged
15 tasks
@deblasis deblasis moved this from Backlog to In Review in V1 Dashboard Mar 27, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in V1 Dashboard Mar 30, 2023
bryanchriswhite added a commit that referenced this issue Mar 31, 2023
@bryanchriswhite
Merge remote-tracking branch 'pokt/main' into HEAD
c09aa70 
* pokt/main:
  [Infra] cluster-manager should not stake validators that are already staked in genesis at startup - Issue #635 (#640)
  [Core] Persistence connection pooling and write context management (#627)
  [Core] Improve module creation documentation - Issue #509 (#623)
  [Tooling][Bug] Fix: changelog verifiers fails to dismiss the review - Issue #638 (#639)
  [CONSENSUS] bugfix for: unable to send txs in localnet - Issue #631 (#632)
bryanchriswhite added a commit that referenced this issue Apr 10, 2023
@bryanchriswhite
Merge branch 'main' into chore/factory-interfaces
7f05708 
* main:
  [Infra] cluster-manager should not stake validators that are already staked in genesis at startup - Issue #635 (#640)
  [Core] Persistence connection pooling and write context management (#627)
  [Core] Improve module creation documentation - Issue #509 (#623)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@deblasis deblasis

Labels
core Core infrastructure - protocol related documentation Improvements or additions to documentation
Projects
V1 Dashboard
Status: Done
Milestone
M1: Pocket PoS (Proof of Stake)
Development

Successfully merging a pull request may close this issue.

[Core] Improve module creation documentation - Issue #509 pokt-network/pocket
1 participant
@deblasis