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: remove require, add example gno doc #3576

Merged
merged 2 commits into from
Jan 23, 2025

Conversation

mous1985
Copy link
Contributor

This pull request is for :

  • remove require statement from official documentation #3123
  • add an example that was //TODO in the effective-gno / Documentation is for users section

add simple example in Documentation is for users
@Gno2D2 Gno2D2 requested review from a team January 21, 2025 18:23
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 21, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Jan 21, 2025

🛠 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 (checked by @thehowl)
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)
🟢 Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff
🟢 Pending initial approval by a review team member (and label matches review triage state)

☑️ 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
└── 🟢 The pull request was created from a fork (head branch repo: mous1985/gno)

Then

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

Changes to 'docs' folder must be reviewed/authored by at least one devrel and one tech-staff

If

🟢 Condition met
└── 🟢 A changed file matches this pattern: ^docs/ (filename: docs/concepts/effective-gno.md)

Then

🟢 Requirement satisfied
└── 🟢 And
    ├── 🟢 Or
    │   ├── 🔴 Pull request author is a member of the team: tech-staff
    │   └── 🟢 At least 1 user(s) of the team tech-staff approved pull request
    └── 🟢 Or
        ├── 🔴 Pull request author is a member of the team: devrels
        └── 🟢 At least 1 user(s) of the team devrels approved pull request

Pending initial approval by a review team member (and label matches review triage state)

If

🟢 Condition met
└── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization approved the 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

@mous1985 mous1985 changed the title docs : remove require statement from Official Documentation and add example for Documentation in gno docs: remove require statement from Official Documentation and add example for Documentation in gno Jan 21, 2025
@Gno2D2 Gno2D2 requested a review from a team January 21, 2025 18:51
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 21, 2025
@Gno2D2 Gno2D2 requested a review from a team January 21, 2025 18:56
@Kouteki Kouteki added in focus 📖 documentation Improvements or additions to documentation labels Jan 22, 2025
@thehowl thehowl changed the title docs: remove require statement from Official Documentation and add example for Documentation in gno docs: remove require, add example gno doc Jan 22, 2025
@Gno2D2 Gno2D2 requested a review from a team January 23, 2025 10:46
@thehowl thehowl merged commit 8851ff4 into gnolang:master Jan 23, 2025
13 checks passed
@mous1985 mous1985 deleted the require-tidy branch January 23, 2025 11:02
stefann-01 pushed a commit to stefann-01/gno that referenced this pull request Jan 24, 2025
This pull request is for :

- remove `require` statement from official documentation
[gnolang#3123](gnolang#3123)
- add an example that was `//TODO` in the `effective-gno / Documentation
is for users` section
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
Development

Successfully merging this pull request may close these issues.

5 participants