Skip to content

Codify the PR review process #3073

@Kouteki

Description

@Kouteki

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions