Skip to content

Documentation: InvokeAI PR review and merge policy#8795

Merged
lstein merged 5 commits intomainfrom
lstein/doc/pr-policy.md
Jan 30, 2026
Merged

Documentation: InvokeAI PR review and merge policy#8795
lstein merged 5 commits intomainfrom
lstein/doc/pr-policy.md

Conversation

@lstein
Copy link
Copy Markdown
Collaborator

@lstein lstein commented Jan 28, 2026

Summary

This PR adds a new developer's document that describes the InvokeAI policy on reviewing and merging pull requests. Please use this PR to comment. The policy is pasted below for your convenience:

Review Process

1. Assignment

One of the repository maintainers will assign collaborators to review a pull request. The assigned reviewer(s) will be responsible for conducting the code review.

2. Review and Iteration

The assignee is responsible for:

  • Reviewing the PR thoroughly
  • Providing constructive feedback
  • Iterating with the PR author until the assignee is satisfied that the PR is fit to merge
  • Ensuring the PR meets code quality standards, follows project conventions, and doesn't introduce bugs or regressions

3. Approval and Notification

Once the assignee is satisfied with the PR:

  • The assignee approves the PR
  • The assignee alerts one of the maintainers that the PR is ready for merge using the #request-reviews Discord channel

4. Final Merge

One of the maintainers is responsible for:

  • Performing a final check of the PR
  • Merging the PR into the appropriate branch

Important: Collaborators are strongly discouraged from merging PRs on their own, except in case of emergency (e.g., critical bug fix and no maintainer is available).

5. Release Policy

Once a feature release candidate is published, no feature PRs are to
be merged into main. Only bugfixes are allowed until the final
release.

Best Practices

Clean Commit History

To encourage a clean development log, PR authors are encouraged to use git rebase -i to suppress trivial commit messages (e.g., ruff and prettier formatting fixes) after the PR is accepted but before it is merged.

Merge Strategy

The maintainer will perform either a 3-way merge or squash merge when merging a PR into the main branch. This approach helps avoid rebase conflict hell and maintains a cleaner project history.

Summary

This policy ensures that:

  • All PRs receive proper review from assigned collaborators
  • Maintainers have final oversight before code enters the main branch
  • The commit history remains clean and meaningful
  • Merge conflicts are minimized through appropriate merge strategies

@github-actions github-actions bot added the docs PRs that change docs label Jan 28, 2026
@JPPhoto
Copy link
Copy Markdown
Collaborator

JPPhoto commented Jan 28, 2026

Not a comment on what's written specifically, but I wonder if there should be a formal feature lockdown between release candidates and releases so that time is purely treated as fixing bugs.

@lstein
Copy link
Copy Markdown
Collaborator Author

lstein commented Jan 28, 2026

Not a comment on what's written specifically, but I wonder if there should be a formal feature lockdown between release candidates and releases so that time is purely treated as fixing bugs.

Yes agree. Bugfixes and translations only between the RC and the release. This would mean that the Z-Image base PR that @Pfannkuchensack is working on now will not go into the upcoming release.

EDIT: Change is added.

@blessedcoolant
Copy link
Copy Markdown
Collaborator

Probably a given but won't hurt to mention under Best Practices that if they are referencing some implementation from elsewhere, then add a comment link to that plus any necessary licensing info.

Rest of it seems good to me.

@lstein lstein enabled auto-merge (squash) January 30, 2026 00:28
@lstein lstein merged commit 5801e59 into main Jan 30, 2026
13 checks passed
@lstein lstein deleted the lstein/doc/pr-policy.md branch January 30, 2026 01:03
dunkeroni pushed a commit to dunkeroni/InvokeAI that referenced this pull request Feb 2, 2026
* docs: Add a PR review and merge policy

* doc(release): add policy on release candidates

* docs(CD/CI): add best practice for external components
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs PRs that change docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants