Skip to content

Commit 2cd58dc

Browse files
authored
Merge pull request #70 from SimonBaeumer/add-pr-template
Add pr template
2 parents 4d1f361 + 1846868 commit 2cd58dc

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
### Prerequisites
2+
3+
* [ ] Can you reproduce the problem in safe mode?
4+
* [ ] Are you running the latest version?
5+
* [ ] Are you reporting to the correct repository?
6+
* [ ] Did you perform a cursory search?
7+
8+
### Description
9+
10+
[Description of the bug or feature]
11+
12+
### Steps to Reproduce
13+
14+
1. [First Step]
15+
2. [Second Step]
16+
3. [and so on...]
17+
18+
**Expected behavior:** [What you expected to happen]
19+
20+
**Actual behavior:** [What actually happened]
21+
22+
### Specifications
23+
24+
- Version:
25+
- Platform:
26+
- Subsystem:
27+
28+
You can get the version information from executing `commander --version`.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Fixes #
2+
3+
## Checklist
4+
5+
- [ ] Added unit / integration tests for windows, macOS and Linux?
6+
- [ ] Added a changelog entry in [CHANGELOG.md](../CHANGELOG.md)?
7+
- [ ] Updated the documentation ([README.md](../README.md), [docs](../docs))?
8+
- [ ] Does your change work on `Linux`, `Windows` and `macOS`?

docs/development.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Development documentation
2+
3+
## Writing integration tests
4+
5+
Commander tests itself. You can find the integration tests in `commander_unix.yaml` and `commander_windows.yaml`.
6+
More complex scenarios are stored in `integration/`.
7+
8+
It is always necessary to execute the test suite with a stable version of commander and not the current build.
9+
10+
**Tipps:**
11+
12+
- The working directory is by default the project root, even for tests located inside `integration/*`
13+
- Execute `commander` inside the `commander_*.yaml` files with a given suite and assert the result which is returned

0 commit comments

Comments
 (0)