docs(commondao): add `README.md` #4678

jeronimoalbi · 2025-08-22T17:48:38Z

Adds an initial README.md to better document the commondao package

Gno2D2 · 2025-08-22T17:49:06Z

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):

IGNORE the bot requirements for this PR (force green CI check)

✅ Automated Checks (for Contributors):

🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:

Fix any issues flagged by automated checks.
Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include BREAKING CHANGE notes.
- Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

Debug

Automated Checks

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 User leohhhn already reviewed PR 4678 with state APPROVED
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Then
        └── 🔴 And
            ├── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)
            └── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request

Manual Checks

**IGNORE** the bot requirements for this PR (force green CI check)
If
🟢 Condition met
└── 🟢 On every pull request
Can be checked by

Any user with comment edit permission

codecov · 2025-08-22T17:59:50Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

examples/gno.land/p/nt/commondao/README.md

leohhhn

LGTM, leaving just one suggestion

leohhhn · 2025-09-02T06:50:09Z

examples/gno.land/p/nt/commondao/README.md

+    VotingPeriod() time.Duration
+
+    // Tally counts the number of votes and verifies if proposal passes.
+    Tally(ReadonlyVotingRecord, MemberSet) (passes bool, _ error)


The ReadonlyVotingRecord type was confusing to me in general. If you could add a simple explanation to what it is and how to use it, that would be great.

Sound good and makes sense to explain it 👍

Done 2e61310

It doesn't explicitly explains why the voting record is readonly, but explains what a voting record is.

It's readonly to avoid proposal definitions to change voting information.

michelleellen · 2025-09-04T09:36:57Z

examples/gno.land/p/nt/commondao/README.md

+This package provides support to implement custom Decentralized Autonomous
+Organizations (DAO).
+
+It aims to be minimal and flexible, allowing the implementation of multiple DAO
+use cases.


Suggested change

This package provides support to implement custom Decentralized Autonomous

Organizations (DAO).

It aims to be minimal and flexible, allowing the implementation of multiple DAO

use cases.

The CommonDAO is a general-purpose implementation of a Decentralized Autonomous Organization (DAO) on Gno.land. The CommonDAO package offers a minimal, and flexible framework for building and deploying DAOs, with customizable options to adapt to across multiple use cases.

Done ba6b83a

Changed it a bit.

michelleellen · 2025-09-04T09:38:22Z

examples/gno.land/p/nt/commondao/README.md

+CommonDAO type is the main type used to define DAOs, allowing standalone DAO
+creation or hierarchical tree based ones.
+
+During creation it accepts many optional arguments some of which are handy


Suggested change

During creation it accepts many optional arguments some of which are handy

During creation. it accepts many optional arguments some of which are handy

Done ba6b83a

michelleellen · 2025-09-04T09:53:03Z

examples/gno.land/p/nt/commondao/README.md

+and description to uniquely identify individual DAOs; Hierarchical ones might
+choose to use slugs instead of IDs, or even a mix of both.
+
+Members can also optionally be initialized during DAO creation.


The 'members can also ...' feels a bit out of place/disconnected from the first part of this content, or maybe it needs more context as to how it relates to the CommonDAO type with a comparison example, initialized before DAO creation vs during DAO creation?

Removed it because it didn't really added anything to the document and it was indeed somehow disconnected.

Done in 28aa1c8

michelleellen · 2025-09-04T09:57:57Z

examples/gno.land/p/nt/commondao/README.md

+are usually used to signal or measure sentiment, for example regarding a
+relevant issue.
+
+Creating a new proposal type requires to implement the following interface:


Suggested change

Creating a new proposal type requires to implement the following interface:

Creating a new proposal type requires implementing the following interface:

Done ba6b83a

michelleellen · 2025-09-04T10:19:57Z

examples/gno.land/p/nt/commondao/README.md

+    Title() string
+
+    // Body returns proposal body.
+    // It usually contains the proposal description and other elements like


Is it worth explaining a few examples of proposal parameters for people who might not know?

Changed description to remove the concept of parameter and used a hopefully simpler description in 0e00c77

Co-authored-by: Michelle <[email protected]>

docs: add initial commondao package README

b3fddd2

jeronimoalbi requested review from ilgooz, salmad3 and leohhhn August 22, 2025 17:48

jeronimoalbi self-assigned this Aug 22, 2025

github-project-automation bot added this to 💪 Bounties & Worx and 🧙‍♂️gno.land core team Aug 22, 2025

github-project-automation bot moved this to Triage in 🧙‍♂️gno.land core team Aug 22, 2025

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Aug 22, 2025

Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Aug 22, 2025

jeronimoalbi requested review from michelleellen and thehowl August 22, 2025 18:00

jeronimoalbi added 2 commits August 22, 2025 20:02

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

30acf51

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

1e1c385

Kouteki self-requested a review August 25, 2025 15:22

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

7830886

matijamarjanovic reviewed Aug 28, 2025

View reviewed changes

examples/gno.land/p/nt/commondao/README.md Show resolved Hide resolved

jeronimoalbi added 2 commits September 1, 2025 14:57

feat: add Vote type documentation to commondao package README

fa17637

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

65d084f

leohhhn approved these changes Sep 2, 2025

View reviewed changes

github-project-automation bot moved this to In Progress in 💪 Bounties & Worx Sep 2, 2025

Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Sep 2, 2025

jeronimoalbi added 3 commits September 2, 2025 15:57

docs: add voting record docs and proposal definition tally

2e61310

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

b79414c

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

fd3e687

michelleellen reviewed Sep 4, 2025

View reviewed changes

jeronimoalbi and others added 4 commits September 5, 2025 09:33

docs: fixes typos

ba6b83a

Co-authored-by: Michelle <[email protected]>

chore: update proposal definition body documentation

0e00c77

chore: remove "redundant" pharagraph

28aa1c8

Merge branch 'master' into feat/jeronimoalbi/commondao-package-readme

da1f135

jeronimoalbi requested a review from michelleellen September 5, 2025 08:07

	During creation it accepts many optional arguments some of which are handy
	During creation. it accepts many optional arguments some of which are handy

	Creating a new proposal type requires to implement the following interface:
	Creating a new proposal type requires implementing the following interface:

docs(commondao): add README.md #4678

Are you sure you want to change the base?

docs(commondao): add README.md #4678

Conversation

jeronimoalbi commented Aug 22, 2025

Uh oh!

Gno2D2 commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛠 PR Checks Summary

Manual Checks (for Reviewers):

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Can be checked by

Uh oh!

codecov bot commented Aug 22, 2025

Codecov Report

Uh oh!

Uh oh!

leohhhn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michelleellen Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

docs(commondao): add `README.md` #4678

docs(commondao): add `README.md` #4678

Gno2D2 commented Aug 22, 2025 •

edited

Loading

michelleellen Sep 4, 2025 •

edited

Loading