Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
- Report a issue template
- Pull request template
- Bug report template
  • Loading branch information
Cevap Master authored Dec 22, 2018
1 parent c4ae3f5 commit 1f38e77
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: BUG_ISSUE_TEMPLATE
about: Report a bug
title: "[BUG]"
labels: Bug
assignees: ckti, MitchellCash, CeForce, cevap, FornaxA

---

<!-- This issue tracker is only for technical issues related to Ion Core.
General ion questions and/or support requests are best directed to the ionomy support support@ionomy.com, Ionomy Discord https://discord.gg/vuZn7gC or even on Bitcoin StackExchange at https://bitcoin.stackexchange.com.
For reporting security issues, please read instructions at support@ionomy.com or call us in US (+1) (844) 237-2721.
If the node is "stuck" during sync or giving "block checksum mismatch" errors, please ensure your hardware is stable by running memtest and observe CPU temperature with a load-test tool such as linpack before creating an issue! -->

<!-- Describe the issue -->
<!--- What behavior did you expect? -->

<!--- What was the actual behavior (provide screenshots if the issue is GUI-related)? -->

<!--- How reliably can you reproduce the issue, what are the steps to do so? -->

<!-- What version of Ion Core are you using, where did you get it (website, self-compiled, etc)? -->

<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->

<!-- Any extra information that might be useful in the debugging process. -->
<!--- 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. -->
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: BUG_REPORT_TEMPLATE
about: Create a report to help us improve Ion Core
title: "[BUG]"
labels: Bug
assignees: ckti, MitchellCash, CeForce, cevap, FornaxA

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: ISSUE_TEMPLATE
about: Report a issue
title: ''
labels: ''
assignees: ckti, MitchellCash, CeForce, cevap, FornaxA

---

<!-- This issue tracker is only for technical issues related to Ion Core.
General ion questions and/or support requests are best directed to the ionomy support support@ionomy.com, Ionomy Discord https://discord.gg/vuZn7gC or even on Bitcoin StackExchange at https://bitcoin.stackexchange.com.
For reporting security issues, please read instructions at support@ionomy.com or call us in US (+1) (844) 237-2721.
If the node is "stuck" during sync or giving "block checksum mismatch" errors, please ensure your hardware is stable by running memtest and observe CPU temperature with a load-test tool such as linpack before creating an issue! -->

<!-- Describe the issue -->
<!--- What behavior did you expect? -->

<!--- What was the actual behavior (provide screenshots if the issue is GUI-related)? -->

<!--- How reliably can you reproduce the issue, what are the steps to do so? -->

<!-- What version of Ion Core are you using, where did you get it (website, self-compiled, etc)? -->

<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->

<!-- Any extra information that might be useful in the debugging process. -->
<!--- 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. -->
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: PULL_REQUEST_TEMPLATE
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ckti, MitchellCash, CeForce, cevap, FornaxA

---

Pull requests without a rationale and clear improvement may be closed
immediately.

Please provide clear motivation for your patch and explain how it improves
Ion Core user experience or Ion Core developer experience
significantly.

* Any test improvements or new tests that improve coverage are always welcome.
* All other changes should have accompanying unit tests (see `src/test/`) or
functional tests (see `test/`). Contributors should note which tests cover
modified code. If no tests exist for a region of modified code, new tests
should accompany the change.
* Bug fixes are most welcome when they come with steps to reproduce or an
explanation of the potential issue as well as reasoning for the way the bug
was fixed.
* Features are welcome, but might be rejected due to design or scope issues.
If a feature is based on a lot of dependencies, contributors should first
consider building the system outside of Ion Core, if possible.
* Refactoring changes are only accepted if they are required for a feature or
bug fix or otherwise improve developer experience significantly. For example,
most "code style" refactoring changes require a thorough explanation why they
are useful, what downsides they have and why they *significantly* improve
developer experience or avoid serious programming bugs. Note that code style
is often a subjective matter. Unless they are explicitly mentioned to be
preferred in the [developer notes](/doc/developer-notes.md), stylistic code
changes are usually rejected.

Ion Core has a thorough review process and even the most trivial change
needs to pass a lot of eyes and requires non-zero or even substantial time
effort to review. There is a huge lack of active reviewers on the project, so
patches often sit for a long time.

0 comments on commit 1f38e77

Please sign in to comment.