Skip to content

Commit bde786c

Browse files
authored
Add initial bounty policy documentation. (#2954)
1 parent 6a00539 commit bde786c

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,11 @@
33
Please see the [main contributing guidelines](./docs/contributing.md).
44

55
There are additional docs describing [contributing documentation changes](./docs/contributing_docs.md).
6+
7+
### GitHub Sponsorship
8+
9+
Testcontainers is [in the GitHub Sponsors program](https://github.com/sponsors/testcontainers)!
10+
11+
This repository is supported by our sponsors, meaning that issues are eligible to have a 'bounty' attached to them by sponsors.
12+
13+
Please see [the bounty policy page](https://testcontainers.org/bounty) if you are interested, either as a sponsor or as a contributor.

docs/bounty.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Testcontainers issue bounty policy
2+
3+
## General
4+
5+
We want to use issue bounties to encourage contributions in areas that are important to our sponsors, or tricky to solve.
6+
This includes bug fixes and new features.
7+
We hope that this will provide incentives to tackle issues, and gives sponsors a way to influence where development time is expended.
8+
We also want to reward our contributors, some of whom make huge efforts to improve Testcontainers and help their fellow developers!
9+
10+
!!! note
11+
It's early days for our use of sponsorship, so we expect to evolve this policy over time, possibly without notice. In the event of any ambiguity or dispute, the [Testcontainers org core maintainers](#organisation-core-maintainers) have the final say.
12+
13+
If you'd like to suggest an improvement to this policy, we'd be grateful for your input - please raise a pull request!
14+
15+
## For Sponsors
16+
17+
Sponsors will be able to create a number of 'bounties' per month, varying according to sponsorship tier.
18+
19+
As a sponsor, the process for creating a bounty is as follows:
20+
21+
* Raise an issue, or find an existing issue that describes the bug or feature.
22+
* Start a discussion with the [Testcontainers org core maintainers](#organisation-core-maintainers) to agree that the issue is suitable for a bounty, and how much the reward amount should be.
23+
* Once agreed, we will assign a label to the issue so that interested developers can find it.
24+
25+
Sponsors can create up to 1 or 3 bounties (according to tier) _per calendar month_ - i.e. the counter resets on the 1st of each month.
26+
If a sponsor does not use their full quota of bounty credits in a calendar month, they cannot be rolled over to the next month.
27+
28+
Bounties will expire 90 days after creation - after this time, if they have not been resolved we will close them.
29+
30+
## For Contributors
31+
32+
As a contributor, the process for working on an issue with a bounty attached is:
33+
34+
* Find an issue with a bounty attached to it and no assignee, clarify the requirements if necessary, and consider how you would approach working on it.
35+
* Start a discussion with the [Testcontainers org core maintainers](#organisation-core-maintainers) and the bounty owner. To avoid unpleasant surprises at review time, we'll try to confirm that we're happy with your proposed solution.
36+
* If we're happy with your proposed solution, we will assign the ticket to you.
37+
* Once work is complete, we will go through the PR process as usual and merge the work when finished.
38+
* To receive the bounty reward, [raise an invoice](https://opencollective.com/testcontainers/expenses/new) on Open Collective, following the expenses policy on that page.
39+
40+
Note that a 20% cut of the bounty amount will normally be assigned to project maintainers for PR review work.
41+
We believe this reflects that PR review can often be a significant amount of work for some issues - and also gives maintainers an incentive to complete the review and unlock the bounty reward!
42+
Some pull requests are so well done that very little review is necessary. If that happens, the maintainers may choose not to take a cut of the bounty, and instead release the full amount to the contributor.
43+
44+
## Organisation core maintainers
45+
46+
The organisation core maintainers are:
47+
48+
* Richard North (@rnorth)
49+
* Sergei Egorov (@bsideup)
50+
* Kevin Wittek (@kiview)
51+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,6 @@ nav:
8989
- Contributing:
9090
- contributing.md
9191
- contributing_docs.md
92+
- bounty.md
9293
extra:
9394
latest_version: 1.14.3

0 commit comments

Comments
 (0)