Skip to content

Commit facef3d

Browse files
author
MarcoFalke
committed
doc: Explain that anyone can work on good first issues, move text to CONTRIBUTING.md
1 parent fae2fb2 commit facef3d

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

.github/ISSUE_TEMPLATE/good_first_issue.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,14 @@ assignees: ''
77

88
---
99

10+
<!-- A good first issue is an uncontroversial issue, that has a relatively unique and obvious solution -->
11+
12+
<!-- Motivate the issue and explain the solution briefly -->
1013

1114
#### Useful skills:
1215

1316
<!-- (For example, “C++11 std::thread”, “Qt5 GUI and async GUI design” or “basic understanding of Bitcoin mining and the Bitcoin Core RPC interface”.) -->
1417

1518
#### Want to work on this issue?
1619

17-
The purpose of the `good first issue` label is to highlight which issues are suitable for a new contributor without a deep understanding of the codebase.
18-
19-
You do not need to request permission to start working on this. You are encouraged to comment on the issue if you are planning to work on it. This will help other contributors monitor which issues are actively being addressed and is also an effective way to request assistance if and when you need it.
20-
2120
For guidance on contributing, please read [CONTRIBUTING.md](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md) before opening your pull request.

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,19 @@ unsure, you might want to leave a comment on the issue first.
3939
You may also participate in the weekly
4040
[Bitcoin Core PR Review Club](https://bitcoincore.reviews/) meeting.
4141

42+
### Good First Issue Label
43+
44+
The purpose of the `good first issue` label is to highlight which issues are
45+
suitable for a new contributor without a deep understanding of the codebase.
46+
47+
However, good first issues can be solved by anyone. If they remain unsolved
48+
for a longer time, a frequent contributor might address them.
49+
50+
You do not need to request permission to start working on an issue. However,
51+
you are encouraged to leave a comment if you are planning to work on it. This
52+
will help other contributors monitor which issues are actively being addressed
53+
and is also an effective way to request assistance if and when you need it.
54+
4255
Communication Channels
4356
----------------------
4457

0 commit comments

Comments
 (0)