Skip to content

Commit

Permalink
Merge pull request #151 from pluto/brunny-eth-patch-1
Browse files Browse the repository at this point in the history
Create bounty.md template for future bounties
  • Loading branch information
brunny-eth authored Sep 10, 2024
2 parents b98ae92 + 00e1cc9 commit b51a583
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bounty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bounty
about: Create a bounty for contributors
title: ''
labels: 'Bounty 💰'
assignees: ''

---

**Bounty description**

A clear and concise description of the project; should be accessible to a contributor with minimal context

**Implementation requirements**

A clear and comprehensive list of the requirements for the bounty to be considered complete.

- [ ] Task 1
- Subtasks (if relevant)
- [ ] Task 2
- Subtasks (if relevant)
- [ ] Task 3
- Subtasks (if relevant)

**Bonus features**

Any additional features that will enhance the value of the bounty.

- [ ] Bonus Feature 1
- [ ] Bonus Feature 2

**Resources**

A list of potentially-useful resources. This list should be less than 5 total resources.

**Criteria**

Bounties will be rewarded based on the following criteria:

1. Correctness and security: A thorough review of the implementation should convince our team that they are correct and secure, with all requirements met.
2. Code clarity and quality: Succinct, easy-to-follow code with appropriate naming conventions. Utilize Rust’s type system for flexibility and security (e.g., compile-time checks where possible), and avoid external crates. Optimizations should be a lower priority than clarity, but can be included behind a feature flag as a bonus.
3. Documentation quality: Provide comprehensive README’s, Cargo docs, and inline comments where code itself is not self-explanatory. Prioritize clarity and readability.

0 comments on commit b51a583

Please sign in to comment.