Contributing

Please Read

This project contains a Contributor Covenant code of conduct all contributors are expected to follow.

Reporting Issues

Please do report an issue on the issue tracker if there’s any bugfix, documentation improvement, or general enhancement you’d like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.

Sending Contributions

Sending your own changes as contribution is always appreciated! There are two steps involved:

1. Finding an Issue
2. Sending a Pull Request

Finding an Issue

With the exception of very small typos, all changes to this repository generally need to correspond to an unassigned open issue marked as status: accepting prs and not ai assigned on the issue tracker. If this is your first time contributing, consider searching for unassigned issues that also have the good first issue label. If the issue you’d like to fix isn’t found on the issue, see Reporting Issues for filing your own (please do!).

Issue Claiming

We don’t use any kind of issue claiming system. We’ve found in the past that they result in accidental “licked cookie” situations where contributors claim an issue but run out of time or energy trying before sending a PR.

If an unassigned issue has been marked as status: accepting prs and an open PR does not exist, feel free to send a PR. Please don’t post comments asking for permission or stating you will work on an issue.

Sending a Pull Request

Once you’ve identified an open issue accepting PRs that doesn’t yet have a PR sent, you’re free to send a pull request. Be sure to fill out the pull request template’s requested information — otherwise your PR will likely be closed.

PRs are also expected to have a title that adheres to conventional commits. Only PR titles need to be in that format, not individual commits. Don’t worry if you get this wrong: you can always change the PR title after sending it. Check previously merged PRs for reference.

Finally, if your PR includes any user-facing changes, run pnpm changeset to add a proper changeset. This should not use traditional conventional commit syntax, and should instead reflect what you would want the user to see in the changelog.
For example, everything after the initial colon in a commit title would be sufficient. This will allow our release automation to version packages appropriately when the next release happens.

Draft PRs

If you don’t think your PR is ready for review, set it as a draft. Draft PRs won’t be reviewed.

Granular PRs

Please keep pull requests single-purpose: in other words, don’t attempt to solve multiple unrelated problems in one pull request. Send one PR per area of concern. Multi-purpose pull requests are harder and slower to review, block all changes from being merged until the whole pull request is reviewed, and are difficult to name well with semantic PR titles.

Pull Request Reviews

When a PR is not in draft, it’s considered ready for review. Please don’t manually @ tag anybody to request review. A team member will look at it when they’re next able to.

PRs should have passing GitHub status checks before review is requested (unless there are explicit questions asked in the PR about any failures).

Asking Questions

If you need help and/or have a question, posting a comment in the PR is a great way to do so. There’s no need to tag anybody individually. A team member will drop by and help when they can.

Please post comments as line comments when possible, so that they can be threaded. You can resolve conversations on your own when you feel they’re resolved - no need to comment explicitly and/or wait for a team member.

Requested Changes

After a team member reviews your PR, they may request changes on it. Once you’ve made those changes, re-request review on GitHub.

Please try not to force-push commits to PRs that have already been reviewed. Doing so makes it harder to review the changes. We squash merge all commits so there’s no need to try to preserve Git history within a PR branch.

Once you’ve addressed all reviewer feedback by making code changes and/or responding to discussion threads, re-request review from each team member whose feedback you addressed.

Once all feedback is addressed and the PR is approved, we’ll ensure the branch is up to date with main and merge it for you.

Post-Merge Recognition

Once your PR is merged, if you haven’t yet been added to the Contributors table in the README.md for the appropriate type of contribution, you should be soon. Please do ping the team member who merged your PR if that doesn’t happen within 48 hours - it was likely an oversight on our end!

Emojis & Appreciation

If you made it all the way to the end of this page, bravo dear user, we love you. Please include an emoji in the bottom of your issues and PRs to signal to us that you did in fact read this file and are trying to conform to it as best as possible. ❤️‍🔥 is a good starter if you’re not sure which to use.