Skip to content

Commit d20b649

Browse files
committed
Merge #477: Update issue templates
8534cd3 Update issue templates (Steve Myers) Pull request description: <!-- You can erase any parts of this template not applicable to your Pull Request. --> ### Description Add bug reporting issue template and template for proposing a "Summer of Bitcoin" project. ### Notes to the reviewers The SoB template is basically a copy of what Adi created but lightly formatted to work as github issue templates. ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) Top commit has no ACKs. Tree-SHA512: 956f7833b7cc1daf4880f74be3886fb17508719af37a247065c463d3f95b1f058bad785590714c609b0e069fe00784bc71cfb0812a79a70c18a2b5bdb22aca6b
2 parents 3a07614 + 8534cd3 commit d20b649

File tree

2 files changed

+103
-0
lines changed

2 files changed

+103
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
**To Reproduce**
14+
<!-- Steps or code to reproduce the behavior. -->
15+
16+
**Expected behavior**
17+
<!-- A clear and concise description of what you expected to happen. -->
18+
19+
**Build environment**
20+
- BDK tag/commit: <!-- e.g. v0.13.0, 3a07614 -->
21+
- OS+version: <!-- e.g. ubuntu 20.04.01, macOS 12.0.1, windows -->
22+
- Rust/Cargo version: <!-- e.g. 1.56.0 -->
23+
- Rust/Cargo target: <!-- e.g. x86_64-apple-darwin, x86_64-unknown-linux-gnu, etc. -->
24+
25+
**Additional context**
26+
<!-- Add any other context about the problem here. -->
+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: Summer of Bitcoin Project
3+
about: Template to suggest a new https://www.summerofbitcoin.org/ project.
4+
title: ''
5+
labels: 'summer-of-bitcoin'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
## Overview
12+
13+
Project ideas are scoped for a university-level student with a basic background in CS and bitcoin
14+
fundamentals - achievable over 12-weeks. Below are just a few types of ideas:
15+
16+
- Low-hanging fruit: Relatively short projects with clear goals; requires basic technical knowledge
17+
and minimal familiarity with the codebase.
18+
- Core development: These projects derive from the ongoing work from the core of your development
19+
team. The list of features and bugs is never-ending, and help is always welcome.
20+
- Risky/Exploratory: These projects push the scope boundaries of your development effort. They
21+
might require expertise in an area not covered by your current development team. They might take
22+
advantage of a new technology. There is a reasonable chance that the project might be less
23+
successful, but the potential rewards make it worth the attempt.
24+
- Infrastructure/Automation: These projects are the code that your organization uses to get its
25+
development work done; for example, projects that improve the automation of releases, regression
26+
tests and automated builds. This is a category where a Summer of Bitcoin student can be really
27+
helpful, doing work that the development team has been putting off while they focus on core
28+
development.
29+
- Quality Assurance/Testing: Projects that work on and test your project's software development
30+
process. Additionally, projects that involve a thorough test and review of individual PRs.
31+
- Fun/Peripheral: These projects might not be related to the current core development focus, but
32+
create new innovations and new perspectives for your project.
33+
-->
34+
35+
**Descriptive Title**
36+
<!-- Description: 3-7 sentences describing the project background and tasks to be done. -->
37+
38+
**Expected Outcomes**
39+
<!-- Short bullet list describing what is to be accomplished -->
40+
41+
**Resources**
42+
<!-- 2-3 reading materials for candidate to learn about the repo, project, scope etc -->
43+
<!-- Recommended reading such as a developer/contributor guide -->
44+
<!-- [Another example a paper citation](https://arxiv.org/pdf/1802.08091.pdf) -->
45+
<!-- [Another example an existing issue](https://github.com/opencv/opencv/issues/11013) -->
46+
<!-- [An existing related module](https://github.com/opencv/opencv_contrib/tree/master/modules/optflow) -->
47+
48+
**Skills Required**
49+
<!-- 3-4 technical skills that the candidate should know -->
50+
<!-- hands on experience with git -->
51+
<!-- mastery plus experience coding in C++ -->
52+
<!-- basic knowledge in matrix and tensor computations, college course work in cryptography -->
53+
<!-- strong mathematical background -->
54+
<!-- Bonus - has experience with React Native. Best if you have also worked with OSSFuzz -->
55+
56+
**Mentor(s)**
57+
<!-- names of mentor(s) for this project go here -->
58+
59+
**Difficulty**
60+
<!-- Easy, Medium, Hard -->
61+
62+
**Competency Test (optional)**
63+
<!-- 2-3 technical tasks related to the project idea or repository you’d like a candidate to
64+
perform in order to demonstrate competency, good first bugs, warm-up exercises -->
65+
<!-- ex. Read the instructions here to get Bitcoin core running on your machine -->
66+
<!-- ex. pick an issue labeled as “newcomer” in the repository, and send a merge request to the
67+
repository. You can also suggest some other improvement that we did not think of yet, or
68+
something that you find interesting or useful -->
69+
<!-- ex. fixes for coding style are usually easy to do, and are good issues for first time
70+
contributions for those learning how to interact with the project. After you are done with the
71+
coding style issue, try making a different contribution. -->
72+
<!-- ex. setup a full Debian packaging development environment and learn the basics of Debian
73+
packaging. Then identify and package the missing dependencies to package Specter Desktop -->
74+
<!-- ex. write a pull parser for CSV files. You'll be judged by the decisions to store the parser
75+
state and how flexible it is to wrap this parser in other scenarios. -->
76+
<!-- ex. Stretch Goal: Implement some basic metaprogram/app to prove you're very familiar with BDK.
77+
Be prepared to make adjustments as we judge your solution. -->

0 commit comments

Comments
 (0)