Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

docs: Describe what a Harper Committer is (#3687)

Elijah Potter68c2eae3b4d5
diff --git a/packages/web/src/routes/docs/contributors/committer/+page.md b/packages/web/src/routes/docs/contributors/committer/+page.md
new file mode 100644
index 000000000..8347564af
--- /dev/null
+++ b/packages/web/src/routes/docs/contributors/committer/+page.md
@@ -0,0 +1,32 @@
+---
+title: What is a Harper Committer
+---
+
+As Harper continues to grow, it’s important to build a team of people capable of making changes within the project. This shares responsibility and avoids bottlenecking progress on a single person. For this purpose, the project has Harper Committers, who are entrusted with elevated privileges within the project and community.
+
+## What a Harper Committer can do
+
+All patches (or “pull requests” in GitHub’s terminology) need to be reviewed and approved by at least one committer before they can be merged. Patches that edit or introduce rules and patches that include only safe bug fixes must be reviewed by at least one committer, even if that committer is also the author. In other words, committers may merge any PR, even their own, as long as it fits that criteria. More complex patches must be reviewed by the project owner (Elijah Potter) specifically.
+
+Committers are also given special administrative permissions in the various official online forums the Harper project runs, including the Discord server.
+
+Committers do not have permission to publish releases or set policy.
+
+## How to Become a Harper Committer
+
+At this time, Elijah Potter, the project lead, maintains the team of Harper Committers at his discretion. Other Harper Committers are encouraged to endorse an individual to be included, which greatly increases the chances of that person being added to the team. The best way to be considered is to be active! As all Harper Committers will have a background of activity and impact within the project.
+
+
+Practical steps for consideration may include:
+
+- The applicant has submitted more than or equal to 15 pull requests which have been approved by a committer and merged into a Harper release.
+- The applicant is in good standing with the community, helping newcomers navigate the pull request process and pushing people in the right direction.
+- An existing committer is willing to personally vouch that the applicant has the qualities of someone who would support the project as a committer.
+
+
+## Maintaining Harper Committer Status
+
+Harper Committers do not need to do anything special to maintain their status. Being honest, helpful, and acting in the interest of Harper’s mission is good enough. Harper Committers do not need to actively commit to maintain their status.
+
+As mentioned above, Elijah Potter is responsible for maintaining and growing the Harper Committer team and therefore may remove members at his discretion. As a note, if a Harper Committer goes inactive for an extended period, their status may be removed for security purposes, and may simply be reinstated upon return.
+
diff --git a/packages/web/src/routes/docs/contributors/committing/+page.md b/packages/web/src/routes/docs/contributors/committing/+page.md
index 2df43be1d..ff3c5251c 100644
--- a/packages/web/src/routes/docs/contributors/committing/+page.md
+++ b/packages/web/src/routes/docs/contributors/committing/+page.md
@@ -7,7 +7,9 @@ Before creating a pull request, please make sure all your commits follow the lin
Additionally, to minimize the labor required to review your commit, we run a relatively strict suite of formatting and linting programs.
We highly recommend that you run both `just format` and `just precommit` before submitting a pull request.
-If those scripts don't work in your environment, we run `just precommit` through GitHub Actions inside of pull requests, so you may make modifications and push until the checks pass.
+If those scripts do not work in your environment, we run `just precommit` through GitHub Actions inside of pull requests, so you may make modifications and push until the checks pass.
-If this sounds intimidating, don't worry.
+Before your changes can be merged into the Harper monorepo, they need to pass all checks and be reviewed by a [committer.](./committer)
+
+If this sounds intimidating, do not worry.
We are entirely willing to work with you to make sure your code can make it into Harper, just know it might take a little longer.
diff --git a/packages/web/src/routes/docs/contributors/introduction/+page.md b/packages/web/src/routes/docs/contributors/introduction/+page.md
index 3459900be..d322998ed 100644
--- a/packages/web/src/routes/docs/contributors/introduction/+page.md
+++ b/packages/web/src/routes/docs/contributors/introduction/+page.md
@@ -4,7 +4,7 @@ title: Introduction to Contributing
Harper is completely open to outside contributions of any kind.
-If you have a feature request or bug to report, please [create an issue](https://github.com/automattic/harper/issues) or ask us [a question on Discord](https://discord.gg/JBqcAaKrzQ) and we'll get back to you as soon as we can.
+If you have a feature request or bug to report, please [create an issue](https://github.com/automattic/harper/issues) or ask us [a question on Discord](https://discord.gg/JBqcAaKrzQ) and we will get back to you as soon as we can.
If you're interested in making a change to the code, we have documentation on [setting up your environment](./environment) and [getting your changes merged in](./committing).
diff --git a/packages/web/vite.config.ts b/packages/web/vite.config.ts
index 5682d7c08..9645f1cb5 100644
--- a/packages/web/vite.config.ts
+++ b/packages/web/vite.config.ts
@@ -215,6 +215,10 @@ export default defineConfig(async () => {
title: 'Reviewing Pull Requests',
to: '/docs/contributors/review',
},
+ {
+ title: 'Committer',
+ to: '/docs/contributors/committer',
+ },
{
title: 'Local Statistics',
to: '/docs/contributors/local-stats',