Skip to content

Commit 18bccbf

Browse files
PolycarpikPolycarpik
authored
Adding issue templates (ChainSafe#615)
* added templates * added issue templates
1 parent d2f93ae commit 18bccbf

File tree

4 files changed

+110
-15
lines changed

4 files changed

+110
-15
lines changed

‎.github/ISSUE_TEMPLATE/backlog-item.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
## Expected Behavior
4+
<!--- If you're describing a bug, tell us what should happen -->
5+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
6+
7+
## Current Behavior
8+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
9+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
10+
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
<!--- or ideas how to implement the addition or change -->
14+
15+
## Steps to Reproduce (for bugs)
16+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
17+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
18+
1.
19+
2.
20+
3.
21+
4.
22+
23+
## Versions
24+
ChainBridge commit (or docker tag):
25+
chainbridge-solidity version:
26+
chainbridge-substrate version:
27+
Go version:

‎.github/ISSUE_TEMPLATE/bug-report.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
## Expected Behavior
4+
<!--- If you're describing a bug, tell us what should happen -->
5+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
6+
7+
## Current Behavior
8+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
9+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
10+
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
<!--- or ideas how to implement the addition or change -->
14+
15+
## Steps to Reproduce (for bugs)
16+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
17+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
18+
1.
19+
2.
20+
3.
21+
4.
22+
23+
## Versions
24+
ChainBridge commit (or docker tag):
25+
chainbridge-solidity version:
26+
chainbridge-substrate version:
27+
Go version:

‎.github/ISSUE_TEMPLATE/feature-epic.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Story
2+
As a <type of user/persona>
3+
I want <to perform some task>
4+
So that I can <achieve some goal/benefit/value>
5+
6+
## Background
7+
<!-- Enter any details that may help to get into context of this task -->
8+
9+
## Details
10+
<!-- Enter any details, clarifications, answers to questions, or points about implementation here -->
11+
12+
## Scenarios
13+
Scenario: <name of scenario>
14+
Given I am <type of user/persona>
15+
When <process any kind of action>
16+
And <additional optional action>
17+
Then <result>
18+
19+
## Implementation details
20+
<!-- Enter description of implementation that may help dev team -->
21+
22+
## Testing details
23+
<!-- Enter description of special test-cases-->
24+
25+
## Acceptance criteria
26+
<!-- Enter the conditions of satisfaction here. That is, the conditions that will satisfy the user/persona that the goal/benefit/value has been achieved -->

‎.github/pull_request_template.md

+30-15
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
1-
<!--
2-
Before submitting a PR please ensure all code is commented and all tests are passing. Make sure to review the changes and ensure that only required changes are included (eg. no unnecessary reformatting by your editor)
3-
-->
1+
<!--- Provide a general summary of your changes in the Title above -->
42

5-
<!-- Brief but specific list of changes made, describe the change in functionality rather than the change in code -->
6-
## Changes
7-
-
8-
-
9-
-
3+
## Description
4+
<!--- Describe your changes in detail -->
105

11-
<!-- Issues that this PR will close -->
12-
<!--
13-
NOTE: you must say 'closes #xx' or 'fixes #xx' for EACH issue this closes.
14-
eg: 'closes #1 and closes #2'
15-
See: https://help.github.com/en/articles/closing-issues-using-keywords
16-
-->
17-
#### Closes: #?
6+
## Related Issue Or Context
7+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
8+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
9+
<!--- Otherwise, describe context and motivation for change herre -->
10+
11+
Closes: #<issue>
12+
13+
## How Has This Been Tested? Testing details.
14+
<!--- Please describe in detail how you tested your changes. -->
15+
<!--- Include details of your testing environment, and the tests you ran to -->
16+
<!--- see how your change affects other areas of the code, etc. -->
17+
18+
## Types of changes
19+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
20+
- [ ] Bug fix (non-breaking change which fixes an issue)
21+
- [ ] New feature (non-breaking change which adds functionality)
22+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
23+
- [ ] Documentation
24+
25+
## Checklist:
26+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
27+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
28+
- [ ] I have commented my code, particularly in hard-to-understand areas.
29+
- [ ] I have ensured that all acceptance criteria (or expected behavior) from issue are met
30+
- [ ] I have updated the documentation locally and in chainbridge-docs.
31+
- [ ] I have added tests to cover my changes.
32+
- [ ] I have ensured that all the checks are passing and green, I've signed the CLA bot

0 commit comments

Comments
 (0)