Skip to content

Commit bcf14ea

Browse files
committed
Encourage contributors to include RELEASE.md files
1 parent 5d8b1b1 commit bcf14ea

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ There are also fake tests that can be used to visualise the output:
5353
pytest faketests
5454
````
5555

56+
When submitting a pull request, please add a `RELEASE.md` file in the root of the project that contains the release type (major, minor, patch) and a summary of the changes that will be used as the release changelog entry. For example:
57+
58+
```markdown
59+
Release type: patch
60+
61+
For long-running tests, display minutes and not only seconds.
62+
```
63+
5664
## Requirements
5765

5866
You will need the following prerequisites in order to use pytest-sugar:

0 commit comments

Comments
 (0)