Skip to content

Commit 79cf558

Browse files
committed
added issue and pull request templates
1 parent debd165 commit 79cf558

3 files changed

Lines changed: 29 additions & 0 deletions

File tree

File renamed without changes.

.github/ISSUE_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## When submitting an issue please include:
2+
* Which version you are running of the software you are running
3+
* Which operating system you are running on
4+
* If available Attach all logs, and or output, and or screenshots
5+
6+
## Please format it in the [given when then style](http://martinfowler.com/bliki/GivenWhenThen.html)
7+
For example (from link above):
8+
9+
**Given**
10+
* I have 100 shares of MSFT stock
11+
* And I have 150 shares of APPL stock
12+
* And the time is before close of trading
13+
14+
**When**
15+
* I ask to sell 20 shares of MSFT stock
16+
17+
**Then**
18+
* I should have 80 shares of MSFT stock
19+
* And I should have 150 shares of APPL stock
20+
* And a sell order for 20 shares of MSFT stock should have been executed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Please ensure you have completed the following before submitting:
2+
- [ ] Ran all tests to ensure existing functionality wasn't broken
3+
- [ ] Ran all quality assurance checks and fixed any new errors or warnings, which include:
4+
* [PMD](https://pmd.github.io/)
5+
* [FindBugs](http://findbugs.sourceforge.net/)
6+
* [Jacoco](http://eclemma.org/jacoco/) code coverage
7+
8+
**Note: you can complete both boxes by running and fixing warnings/errors with** `gradle clean check`
9+
- [ ] Code is [self documenting](https://en.wikipedia.org/wiki/Self-documenting_code) or a short comment when self documenting isn't possible

0 commit comments

Comments
 (0)