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

Codify the PR review process #3073

Open
3 tasks
Kouteki opened this issue Nov 6, 2024 · 2 comments
Open
3 tasks

Codify the PR review process #3073

Kouteki opened this issue Nov 6, 2024 · 2 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation

Comments

@Kouteki
Copy link
Contributor

Kouteki commented Nov 6, 2024

Description

We aim to formalize our pull request review process to ensure consistency, quality, and clarity for all contributors. This issue proposes the creation of guidelines that outline the steps, expectations, and criteria for PR reviews on this project. Everyone joining the gno.land project looking to contribute will be able to onboard faster and maintain code quality.

Acceptance criteria

  • Create a 1st version of the document that codifies the following:
    • Define Roles and Responsibilities: Outline roles in the PR process. Specify any approval requirements or permissions.
    • Set Criteria for Review and Approval: Establish what constitutes a "ready for review" PR (e.g., description, tests, documentation). Create a checklist of items for reviewers to assess (e.g., code style, functionality, compatibility).
    • Timeliness and Frequency: Define expectations for the time reviewers have to respond to PRs. Suggest a process for handling unresponsive PRs or when additional reviewers are needed.
    • Feedback and Revision Process: Outline guidelines for providing constructive feedback. Define how contributors should address review comments and mark revisions as complete.
    • Merge and Close Process: Establish who is authorized to merge PRs and under what conditions. Clarify when and how PRs should be closed if they become inactive or cannot be completed.
  • Gather feedback from the community and adjust based on input.
  • Finalize and add the document to the gno.land documentation

Appendix

Review team RFC

@thehowl
Copy link
Member

thehowl commented Nov 6, 2024

#2477

@thehowl thehowl mentioned this issue Nov 6, 2024
2 tasks
@moul
Copy link
Member

moul commented Nov 6, 2024

#3037, #1007, #1466, #2788

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

No branches or pull requests

3 participants