You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To Test: PRs that need to be built locally & tested to verify the bug is gone (see below)
Approved: Nothing left here, it should be ready to merge (see below)
To Redo: PRs that should be re-made partially or from scratch, using up-to-date assets/..
Not Ready Yet: PRs that are still WIP, that are not ready yet
(Don't want: PRs that I definitely don't want in the project, nothing to do here)
How to help out
NOTE: Some parts of this guide could be extracted into a dedicated contribution guide at some point 🤔
Help review an upstream PR
(reserved to people with Rust / Software development experience)
Check the related issue(s), is this the correct change for the issue(s) root-cause?
Check the changes are maintainable (functions/non-obvious changes should reference external specs, mention WHY something is needed)
Check for AI usage, see the project AI Policy. (TODO link to it!)
...?
If the PR author isn't around anymore or the requested changes are non-blocking, we can merge the original PR and do a follow-up one with eventual patches. (mention them in original PR)
Help test an upstream PR
The goal is to verify that the changes work as expected / solve the issue(s) root-cause.
Define an automatic or manual testing strategy, use repro steps (env setup, script, custom config, ..), try to think about edge cases to test
(Build the project locally and try the auto/manual test (should fail))
Checkout the PR
Build the project locally and try the auto/manual test again (should work!)
Report findings on the PR
Might need a proper Review if not done already.
Help merge an approved upstream PR
Trivial changes (e.g. docs):
These will probably be merged quickly directly to the main branch.
Important
Need to prepare how we'll merge PRs, see #9
Upstream WezTerm PRs considered for inclusion in RezTerm are listed in https://github.com/orgs/rezterm-org/projects/2.
They are categorized into different status:
To Review: PRs that need review (see below)To Test: PRs that need to be built locally & tested to verify the bug is gone (see below)Approved: Nothing left here, it should be ready to merge (see below)To Redo: PRs that should be re-made partially or from scratch, using up-to-date assets/..Not Ready Yet: PRs that are still WIP, that are not ready yetDon't want: PRs that I definitely don't want in the project, nothing to do here)How to help out
NOTE: Some parts of this guide could be extracted into a dedicated contribution guide at some point 🤔
Help review an upstream PR
(reserved to people with Rust / Software development experience)
If the PR author isn't around anymore or the requested changes are non-blocking, we can merge the original PR and do a follow-up one with eventual patches. (mention them in original PR)
Help test an upstream PR
The goal is to verify that the changes work as expected / solve the issue(s) root-cause.
Might need a proper Review if not done already.
Help merge an approved upstream PR
Trivial changes (e.g. docs):
These will probably be merged quickly directly to the main branch.
Others:
Workflow TBD 🤔
NOTE: The goal is not to merge ALL PRs in https://github.com/orgs/rezterm-org/projects/2 before first release, but most of them I think yes 🤔