Skip to content

Commit ce2e282

Browse files
Merge pull request #347 from matt-auckland/github-templates
Added github issue and pr templates
2 parents 477698e + d28e264 commit ce2e282

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- This issue tracker is only for technical issues related to NavCoin Core.
2+
3+
General NavCoin questions and/or support requests are best directed to the NavCoin Discord or subreddit
4+
5+
For reporting security issues, please read instructions at https://navcoin.org/en/responsible-disclosure.
6+
7+
<!-- Describe the issue -->
8+
<!--- What behavior did you expect? -->
9+
10+
<!--- What was the actual behavior (provide screenshots if the issue is GUI-related)? -->
11+
12+
<!--- How reliably can you reproduce the issue, what are the steps to do so? -->
13+
14+
<!-- What version of NavCoin Core are you using, where did you get it (website, self-compiled, etc)? -->
15+
16+
<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
17+
18+
<!-- Any extra information that might be useful in the debugging process. -->
19+
<!--- This is normally the contents of a `debug.log` or `config.log` file. Raw text or a link to a pastebin type site are preferred. -->

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Pull requests without a rationale and clear improvement may be closed
2+
immediately.
3+
4+
Please provide clear motivation for your patch and explain how it improves
5+
NavCoin Core user experience or NavCoin Core developer experience
6+
significantly.
7+
8+
* Any test improvements or new tests that improve coverage are always welcome.
9+
* All other changes should have accompanying unit tests (see `src/test/`) or
10+
functional tests (see `qa/`). Contributors should note which tests cover
11+
modified code. If no tests exist for a region of modified code, new tests
12+
should accompany the change.
13+
* Bug fixes are most welcome when they come with steps to reproduce or an
14+
explanation of the potential issue as well as reasoning for the way the bug
15+
was fixed.
16+
* Features are welcome, but might be rejected due to design or scope issues.
17+
If a feature is based on a lot of dependencies, contributors should first
18+
consider building the system outside of NavCoin Core, if possible.
19+
* Refactoring changes are only accepted if they are required for a feature or
20+
bug fix or otherwise improve developer experience significantly. For example,
21+
most "code style" refactoring changes require a thorough explanation why they
22+
are useful, what downsides they have and why they *significantly* improve
23+
developer experience or avoid serious programming bugs. Note that code style
24+
is often a subjective matter. Unless they are explicitly mentioned to be
25+
preferred in the [developer notes](/doc/developer-notes.md), stylistic code
26+
changes are usually rejected.
27+
28+
NavCoin Core has a thorough review process and even the most trivial change
29+
needs to pass a lot of eyes and requires non-zero or even substantial time
30+
effort to review. There is a huge lack of active reviewers on the project, so
31+
patches often sit for a long time.

0 commit comments

Comments
 (0)