Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add Financial Contributions section to GOVERNANCE #2693

Merged
merged 12 commits into from
May 9, 2024
113 changes: 90 additions & 23 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Governance

This document outlines the governance model for Biome. This document includes the contributor model, code review, merging, and the consequences and process for Code of Conduct violations.
This document outlines the governance model for Biome.

## Member Roles
It describes various parts of how the project is managed as well as accepted practices for day-to-day operation:

- [Contributor Model](#contributor-model)
- [Project Direction](#project-direction)
- [Code Review](#code-review)
- [Financial Contributions](#financial-contributions)
- [Moderation](#moderation)

## Contributor Model

All members must follow the [Code of Conduct](CODE_OF_CONDUCT.md). Consequences for member violations are detailed in [Moderation](#moderation).

Expand Down Expand Up @@ -49,6 +57,7 @@ Core Contributors are outstanding [maintainers](#maintainer), are ambassadors of
- Takes part in [project decisions](#project-direction-and-planning)
- Ability to [vote](#maintainer-nomination) on new maintainers and [vote](#core-contributor-nomination) on new core contributors
- Onboard new [maintainers](#maintainer)
- Assign [pledges to issues](#bounties).

#### Core contributor nomination

Expand Down Expand Up @@ -139,7 +148,7 @@ Contributions to the project aren't only limited to code. Contributions come in
- Support in secondary channels, e.g. StackOverflow, etc.
- Website;

## Project direction and planning
## Project Direction

Project direction and planning is a shared responsibility amongst members. Core contributors are responsible for dictating high-level goals and the project scope that should be adhered to.

Expand All @@ -165,6 +174,84 @@ We have a reasonably liberal approach to code review and merging. We value quick
- All code must go through Pull Requests (PR) and pass status checks before being merged. If a PR is merged that breaks `main` due to the branch not being up-to-date, then it should either be reverted or a quick fix merged as a separate PR.
- If a PR is against code you have previously committed and is either small changes, bug fixes, or refactors, then you're free to merge it without any review. However, if you need more confidence in your changes, you can wait for approval from another maintainer or core contributor.

## Financial Contributions

Biome is in the fortunate position that people care enough about it that they want to invest financially in its future. However, with money comes responsibility, so we are committed to the following.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

There are two ways to fund Biome and its development: sponsorship and funded bounties, although we strongly prefer sponsorship.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

### Sponsorship

Sponsorship is the first and foremost way of making financial contributions to Biome. Sponsorship can be
done through a one-time donation, or through recurring donations. We offer incentives for certain levels of recurring donations.

To learn more about sponsorship incentives, or to make a donation, please visit our [Open Collective page](https://opencollective.com/biome).
You can also sponsor the project through [GitHub](https://github.com/sponsors/biomejs).

### Community-Funded Bounties
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a personal preference, but I don't like the term "Bounty". I am more keen to use the term "project" or "issue":

  • that's Polar's terminology
  • we already identified "bounties" that aren't small things, but are big features that require time and work to complete

As far as I've seen out there, bounties are just for "small" things that contributors can easily achieve.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if there's a better alternative, but the words "issue" and "project" are already used for units of work, which may or may not be funded. The word "bounty" unambiguously clarifies there's a financial reward for a unit of work. The Polar terminology makes sense within their realm, since the platform is all about funding, so they differentiate "issues" from other financial transactions, but applying that terminology to Biome would be more confusing than helpful, I think.

I don't think there's an implication that bounties should only be for small things. That should be reflected in the pledged amount instead. But I do think issues with a bounty attached shouldn't become too big, hence the $1000 maximum. If a task is so large we feel $1000 doesn't cover the effort, it would be better to split it into multiple tasks with separate bounties.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Community-funded issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can change the header, yes. But the word bounty is used all-over the place in this doc, and using the full phrase "Community-funded issue" everywhere seems quite burdensome. Assuming we don't want to ban the word bounty altogether, I'm not a fan of changing the header either, since it would only create a disconnect between the terminology used.


Bounties are the second approach towards funding Biome development. Unlike a sponsorship, bounties are directed towards the completion of a specific task. Tasks include, but are not limited to, the development of a feature or the fixing of a bug.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

Compared to sponsorship, bounties come with a few risks, both for Biome as a project, as well as the persons or entities offering and collecting the bounty. To minimize these risks, we only sanction bounties under the following conditions:
arendjr marked this conversation as resolved.
Show resolved Hide resolved

- Bounties must be pledged through Polar.sh on an issue that is opened in our issue tracker.
- Unless otherwise specified, Biome reserves 30% of the payment amount, meaning contributors receive 70% of the pledged amount.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know if 70/30 is the usual amount for bounties?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I don't. I would be leaning to either 70/30 or 80/20, but it's hard to say which should be preferred. And the range as a whole is more a gut-feeling than anything.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add a new phrase saying that we reserve the right to change the percentage based on the amount of time Maintainers and Core contributors would need to spend coaching the contributors and reviewing the PRs.

- The commission charged by Polar.sh is split accordingly.
- If an issue in our issue tracker is not yet open for pledges, the person who wishes to pledge should indicate their desire in the comments of the issue, or do so through the `Community > #bounties` channel on Discord. A core contributor can then **accept** or **reject** the request for the bounty. Reasons for rejection include, but are not limited to:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of things:

  • I would change #bounties to #funding. A broader channel, so we can also chat about sponsorships and such
  • It should be "Core contributor" because that's the name of the role (capital C). nit: we could add a link to the header of the "Core contributors".
  • We should state how the core contributor decides that. As a suggestion, we could make a vote/poll in Discord and state that the voting rules will be the same as the ones used for voting new core contributors

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All done, except the last point: I wonder if/hope it might be sufficient for now to let core contributors make these decisions at their own discretion, as long as it fits within the rest of the rules as stated in this document. Do we think a poll is necessary for each bounty request?

- Implementation of the task would conflict with the project direction or [its values](https://biomejs.dev/internals/philosophy/).
- Implementation of the task is (currently) technically infeasible.
- The suggested pledge is deemed inappropriate for the amount of work involved.
- The person making the pledge acknowledges their pledge does not come with a guarantee of work done.
- A task is only completed when a Biome maintainer merges the pull request that closes the task. The person trying to complete the task is responsible for addressing review comments to make sure the work meets the quality standards of the Biome project.
arendjr marked this conversation as resolved.
Show resolved Hide resolved
- There is a 6 month expiration on pledges, as managed by Polar.sh.
- Terms and conditions of Polar.sh apply to all pledges.
- For the FAQ, please see: https://docs.polar.sh/maintainers/faq/
- For the legal terms, please see: https://polar.sh/legal/terms
- If you are receiving money as part of a bounty, please consider whether you need to pay taxes in your country.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

### Project-Funded Bounties

In some cases, Biome funds bounties on its own issues. For project-funded bounties, the same conditions apply as for community-funded bounties. But given that these issues are funded by money from our sponsors, we have additional restrictions in place:
arendjr marked this conversation as resolved.
Show resolved Hide resolved
arendjr marked this conversation as resolved.
Show resolved Hide resolved

- Implementation of the task funded by Biome must advance [our roadmap](#roadmap) or help with essential infrastructure.
- The description of the task must include a clear rationale for why this task is eligible for funding.
- Each Biome-funded task will be either assigned directly to a contributor, or assigned a label to indicate who is eligible for picking up that task:
- `F-Anyone`: Anyone is free to pick up this task. This task should be of low complexity and has a maximum bounty of $50 (USD).
- `F-Maintainers`: Any Biome maintainer is free to pick up this task. This task may be of medium complexity and has a maximum bounty of $200 (USD).
- `F-Core-Contributors`: Only core contributors are eligible for picking this task. There is no upper limit to the complexity, but the maximum bounty is $1000 (USD).
- For Biome-funded tasks assigned to core contributors, we ask the contributor to take the money directly from our Open Collective account, instead of using Polar.sh. This will help us avoid paying commission over the larger bounties.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

Additionally, there is a strict process for assigning project-funded bounties:

- To request Biome funding for a task, a request with a clear rationale must be made in the `Community > #bounties` channel on Discord.
- Merely commenting on a GitHub issue is not sufficient, to make sure project members have a better chance at monitoring requests.
arendjr marked this conversation as resolved.
Show resolved Hide resolved
- If the request is approved by at least 2 maintainers and not vetoed by any core contributor within 7 days, then a core contributor can assign the pledge to the issue and assign the requester or a corresponding label to it.
arendjr marked this conversation as resolved.
Show resolved Hide resolved
- The waiting period is not necessary if a lead approves the request.
- There is a maximum amount of issues with pledges someone can have assigned to them. The limit is 2 for core contributors, and 1 for anyone else.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

Finally, there is one more important distinction from community-funded bounties: Since Biome is the one funding the issue, **100% of the pledged amount will go to the contributor completing the task**.
arendjr marked this conversation as resolved.
Show resolved Hide resolved

### Fund Allocation

**Funds will be allocated for project-specific services**:
- Domain registrations
- Website hosting
- Password manager to manage secrets and passwords among Lead members

#### Expenses

Core contributors are allowed to claim expenses related to conferences where they talk about Biome, or Biome workshops that they run. Expenses that can be claimed include, but are not limited to: trip (plane, train, etc.), meals, transport, parking.
- The person will have to provide proof of attendance (badge, video, etc.);
- Expenses will have to be uploaded via the open collective website.
- Only the expenses that are afforded in the days of the workspace/conference are accepted:
- If a conference lasts multiple days and the member decides to attend *both* days, and the member speaks only the first day, only the expenses of the first day should be taken in consideration. In this example, if the member booked three nights in a hotel to attend these two days, the expense should be divided by 3 - three nights - and only expense 2 days: night before the conference, plus the night of the day the member speaks.
- If a conference lasts one day and the member decides to make their performance longer, all the expenses afforded in the other days won't be accepted. Only 2 nights of accommodation are accepted.

Expenses must be approved by at least one [lead](#lead). In the presence of one single lead, the lead will ask one core contributor to fact-check the honesty of expenses, and leave a comment in the Open Collective expense page. In case of multiple leads, the lead submitting the expense must seek the approval of at least one other lead.

> [!NOTE]
> Other usage of funds has yet to be decided.

## Moderation

Outlined below is the process for Code of Conduct violation reviews.
Expand Down Expand Up @@ -210,25 +297,5 @@ The reviewers will determine responses based on the information gathered and the
- Permanent ban from the GitHub org and Discord server
- Revoked contributor or moderator status

## OpenCollective fund allocation

**Funds will be allocated for project-specific services**:
- Domain registrations
- Website hosting
- Password manager to manage secrets and passwords among Lead members

Core contributors are allowed to claim expenses related to conferences where they talk about Biome, or Biome workshops that they run. Expenses that can be claimed are but not limited to: trip (plane, train, etc.), meals, transport, parking.
- The person will have to provide proof of attendance (badge, video, etc.);
- Expenses will have to be uploaded via the open collective website.
- Only the expenses that are afforded in the days of the workspace/conference are accepted:
- If a conference lasts multiple days and the member decides to attend *both* days, and the member speaks only the first day, only the expenses of the first day should be taken in consideration. In this example, if the member booked three nights in a hotel to attend these two days, the expense should be divided by 3 - three nights - and only expense 2 days: night before the conference, plus the night of the day the member speaks.
- If a conference lasts one day and the member decides to make their performance longer, all the expenses afforded in the other days won't be accepted. Only 2 nights of accommodation are accepted.

Expenses must be approved by at least one [lead](#lead). In the presence of one single lead, the lead will ask one core contributor to fact-check the honesty of expenses, and leave a comment in the Open Collective expense page. In case of multiple leads, the lead submitting the expense must seek the approval of at least one other lead.

> [!NOTE]
> Other usage of funds has yet to be decided.


[gh-org]: https://github.com/biomejs
[discord]: https://discord.gg/BypW39g6Yc±