Skip to content

Commit 28646d6

Browse files
committed
reworked PR template
1 parent e5eefa1 commit 28646d6

File tree

3 files changed

+28
-50
lines changed

3 files changed

+28
-50
lines changed

.github/PULL_REQUEST_TEMPLATE/config.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/PULL_REQUEST_TEMPLATE/recipes.yaml

Lines changed: 0 additions & 49 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contribution in a nutshell
2+
Hey, this could help our community 🌱
3+
4+
# Scope
5+
* [ ] I want to get done ...
6+
* [ ] ... and hope to also achieve ...
7+
8+
# Notes for reviewing (optional)
9+
This change has these implication which might need attention over here; —how should we tackle this?
10+
11+
# Pre-review
12+
* [ ] (if applicable) add an `extra_requirements.txt` file
13+
* [ ] (if applicable) add database preparation scripts & use symlinks for nested folders (to the level of task READMEs)
14+
* [ ] (if applicable) add a recipe test entry in the depending CSV file under: tests/recipes
15+
* [ ] create a fresh testing environment (install SpeechBrain from cloned repo branch of this PR)
16+
* [ ] (if applicable) run a recipe test for each yaml/your recipe dataset
17+
* [ ] check function comments: are there docstrings w/ arguments & returns? If you're not the verbose type, put a comment every three lines of code (better: every line)
18+
* [ ] use CI locally: `pre-commit run -a` to check linters; run `pytest tests/consistency`
19+
* [ ] (optional) run `tests/.run-doctests.sh` & `tests/.run-unittests.sh`
20+
* [ ] exhausted patience before clicking « Ready for review » in the merge box 🍄
21+
22+
---
23+
24+
Note: when merged, we desire to include your PR title in our contributions list, check out one of our past version releases
25+
https://github.com/speechbrain/speechbrain/releases/tag/v0.5.14
26+
27+
Tip: below, on the « Create Pull Request » use the drop-down to select: « Create Draft Pull Request » – your PR will be in draft mode until you declare it « Ready for review »
28+

0 commit comments

Comments
 (0)