gno icon indicating copy to clipboard operation
gno copied to clipboard

docs: commondao documentation

Open Chaegnal opened this issue 5 months ago • 10 comments

A documentation for commondao pure package.

Implements a very basic DAO through the pure package commondao as to demonstrate how the /p is used. Creation of a basic DAO, creation of proposals and voting are included in the documentation.

Chaegnal avatar Jul 10 '25 15:07 Chaegnal

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • [ ] IGNORE the bot requirements for this PR (force green CI check)
  • [ ] The pull request description provides enough details
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info) 🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. 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:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: Chaegnal/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

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 satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🔴 At least one of these user(s) reviewed the pull request: [jefft0 leohhhn n0izn0iz notJoon omarsy x1unix] (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

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
The pull request description provides enough details

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])

Can be checked by

  • team core-contributors

Gno2D2 avatar Jul 10 '25 15:07 Gno2D2

Hey, is this ready for review? If so, please make it ready for review :)

leohhhn avatar Jul 15 '25 12:07 leohhhn

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests.

:loudspeaker: Thoughts on this report? Let us know!

codecov[bot] avatar Jul 15 '25 13:07 codecov[bot]

Also, ideally add a bit of a PR description and follow the correct PR title naming patterns (example)

leohhhn avatar Jul 15 '25 13:07 leohhhn

Also, ideally add a bit of a PR description and follow the correct PR title naming patterns (example)

Just changed it, don't know why it took that name as I did not specify any PR name.

Chaegnal avatar Jul 15 '25 13:07 Chaegnal

I already changed it for you: Screenshot 2025-07-15 at 15 58 03

it's because if you don't provide the PR title it takes the branch name or something similar

leohhhn avatar Jul 15 '25 13:07 leohhhn

It might be out of scope but if possible it would be great to have tests, to be sure the documentation realm works as expected

jeronimoalbi avatar Jul 23 '25 08:07 jeronimoalbi

This PR is stale because it has been open 3 months with no activity. Remove stale label or comment or this will be closed in 3 months.

github-actions[bot] avatar Nov 11 '25 02:11 github-actions[bot]

Core dev jeronimoalbi has approved. Ready for core team review.

jefft0 avatar Dec 10 '25 12:12 jefft0

@jeronimoalbi Please add any changes you think are good to go, and go ahead and merge :+1:

thehowl avatar Dec 10 '25 13:12 thehowl