Skip to content

Commit 5f55c47

Browse files
committed
new issue/PR templates
1 parent 6351909 commit 5f55c47

4 files changed

Lines changed: 127 additions & 11 deletions

File tree

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!--
2+
Thank you for your contribution and taking the time to report the issue!
3+
Note: Please search to see if an issue already exists for the bug you encountered.
4+
-->
5+
6+
---
7+
name: 🐞 Bug
8+
about: File a bug/issue
9+
title: '[BUG] <title>'
10+
labels: Bug, Needs Triage
11+
assignees: ''
12+
13+
---
14+
15+
16+
### Current Behavior:
17+
<!-- A concise description of what you're experiencing. -->
18+
19+
### Expected Behavior:
20+
<!-- A concise description of what you expected to happen. -->
21+
22+
### Steps To Reproduce:
23+
<!--
24+
Example: steps to reproduce the behavior:
25+
1. In this environment...
26+
1. With this config...
27+
1. Run '...'
28+
1. See error...
29+
30+
or a minimal example
31+
-->
32+
33+
### Environment:
34+
<!--
35+
Example:
36+
- OS: Ubuntu 20.04
37+
- Python: 3.14.0
38+
- xmlrunner: 4.0.0
39+
output of `pip list`
40+
-->
41+
42+
### Anything else:
43+
<!--
44+
Links? References? Anything that will give us more context about the issue that you are encountering!
45+
-->
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!--
2+
Thank you for your contribution and taking the time to report the issue!
3+
Note: Please search to see if an issue already exists for the bug you encountered.
4+
-->
5+
6+
---
7+
name: 🚀 Feature Request
8+
about: File a feature request
9+
title: '[Feature] <title>'
10+
labels: Feature, Needs Triage
11+
assignees: ''
12+
13+
---
14+
15+
16+
### Current Behavior:
17+
<!--
18+
Explain why the current behavior has shortcomings.
19+
-->
20+
21+
### Feature Behavior:
22+
<!--
23+
A detailed description of the feature.
24+
Explain the pros/cons of this approach.
25+
Explain the target audience for this feature,
26+
e.g. is it for a very niche use case? or will everybody use it?
27+
-->
28+
29+
### Test Plan for the feature
30+
<!--
31+
How to test the new feature and ensure it plays nice with other existing features.
32+
How to verify that it works?
33+
Ideas for unit tests?
34+
-->
35+
36+
### Alternative solutions:
37+
<!--
38+
Explain how you are currently achieving the results a different way.
39+
Explain the pros/cons of the alternative solutions.
40+
-->
41+
42+
### Environment:
43+
<!--
44+
Example:
45+
- OS: Ubuntu 20.04
46+
- Python: 3.14.0
47+
- xmlrunner: 4.0.0
48+
output of `pip list`
49+
-->
50+
51+
### Anything else:
52+
<!--
53+
Links? References?
54+
Anything that will give us more context about the feature request!
55+
-->

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!--
2+
Thank you for submitting a PR and your contribution!
3+
4+
Quick checklist
5+
6+
- [ ] Include unit tests when applicable
7+
- [ ] Documentation and comments
8+
- [ ] Reference existing issues, e.g. `see issue #123`, `closes #123`
9+
- [ ] Reference existing pull requests, e.g. `supersedes PR #123`
10+
11+
See the [github docs](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) for more information.
12+
13+
-->

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[![codecov.io Coverage Status](https://codecov.io/github/xmlrunner/unittest-xml-reporting/coverage.svg?branch=master)](https://codecov.io/github/xmlrunner/unittest-xml-reporting?branch=master)
77
[![Coveralls Coverage Status](https://coveralls.io/repos/xmlrunner/unittest-xml-reporting/badge.svg?branch=master&service=github)](https://coveralls.io/github/xmlrunner/unittest-xml-reporting?branch=master)
8-
[![Requirements Status](https://requires.io/github/xmlrunner/unittest-xml-reporting/requirements.svg?branch=master)](https://requires.io/github/xmlrunner/unittest-xml-reporting/requirements/?branch=master)
8+
99

1010
# unittest-xml-reporting (aka xmlrunner)
1111

@@ -14,9 +14,21 @@ The files can be consumed by a wide range of tools, such as build systems, IDEs
1414
and continuous integration servers.
1515

1616

17+
## Contributing
18+
19+
We are always looking for good contributions, so please just fork the
20+
repository and send pull requests (with tests please!).
21+
22+
If you would like write access to the repository, or become a maintainer,
23+
feel free to get in touch.
24+
25+
1726
## Requirements
1827

19-
* Python 3.7+
28+
See [Status of Python versions](https://devguide.python.org/versions/) for python EOL information.
29+
30+
* Python 3.10+
31+
* Last version supporting Python 3.7 - 3.9 was 3.2.0
2032
* Please note Python 3.6 end-of-life was in Dec 2021, last version supporting 3.6 was 3.1.0
2133
* Please note Python 3.5 end-of-life was in Sep 2020, last version supporting 3.5 was 3.1.0
2234
* Please note Python 2.7 end-of-life was in Jan 2020, last version supporting 2.7 was 2.5.2
@@ -242,15 +254,6 @@ Also, the following settings are provided so you can fine tune the reports:
242254
|`TEST_OUTPUT_FILE_NAME`|`None`|`<str>`|Tells the test runner to output a single XML report with this filename under `os.path.join(TEST_OUTPUT_DIR, TEST_OUTPUT_FILE_NAME)`.<br>Please note that for long running tests, this will keep the results in memory for a longer time than multiple reports, and may use up more resources.|
243255

244256

245-
## Contributing
246-
247-
We are always looking for good contributions, so please just fork the
248-
repository and send pull requests (with tests!).
249-
250-
If you would like write access to the repository, or become a maintainer,
251-
feel free to get in touch.
252-
253-
254257
### Testing changes with `tox`
255258

256259
Please use `tox` to test your changes before sending a pull request.

0 commit comments

Comments
 (0)