|
1 | | -# Contribution in a nutshell |
2 | | -Hey, this could help our community 🌱 |
| 1 | +## What does this PR do? |
3 | 2 |
|
4 | | -# Scope |
5 | | -* [ ] I want to get done ... |
6 | | -* [ ] ... and hope to also achieve ... |
| 3 | +<!-- |
| 4 | +Please include a summary of the change and which issue is fixed. |
| 5 | +Please also include relevant motivation and context. |
| 6 | +List any dependencies that are required for this change. |
7 | 7 |
|
8 | | -# Notes for reviewing (optional) |
9 | | -This change has these implication which might need attention over here; —how should we tackle this? |
| 8 | +--> |
10 | 9 |
|
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 🍄 |
| 10 | +Fixes #<issue_number> |
21 | 11 |
|
22 | | ---- |
| 12 | +<!-- Does your PR introduce any breaking changes? If yes, please list them. --> |
23 | 13 |
|
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 |
| 14 | +<details> |
| 15 | + <summary><b>Before submitting</b></summary> |
26 | 16 |
|
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 » |
| 17 | +- [ ] Did you read the [contributor guideline](https://speechbrain.readthedocs.io/en/latest/contributing.html)? |
| 18 | +- [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together? |
| 19 | +- [ ] Did you make sure to **update the documentation** with your changes? (if necessary) |
| 20 | +- [ ] Did you write any **new necessary tests**? (not for typos and docs) |
| 21 | +- [ ] Did you verify new and **existing [tests](https://github.com/speechbrain/speechbrain/tree/develop/tests) pass** locally with your changes? |
| 22 | +- [ ] Did you list all the **breaking changes** introduced by this pull request? |
| 23 | +- [ ] Does your code adhere to project-specific code style and conventions? |
28 | 24 |
|
| 25 | +</details> |
| 26 | + |
| 27 | +## PR review |
| 28 | + |
| 29 | +<details> |
| 30 | + <summary>Reviewer checklist</summary> |
| 31 | + |
| 32 | +- [ ] Is this pull request ready for review? (if not, please submit in draft mode) |
| 33 | +- [ ] Check that all items from **Before submitting** are resolved |
| 34 | +- [ ] Make sure the title is self-explanatory and the description concisely explains the PR |
| 35 | +- [ ] Add labels and milestones (and optionally projects) to the PR so it can be classified |
| 36 | +- [ ] Confirm that the changes adhere to compatibility requirements (e.g., Python version, platform) |
| 37 | +- [ ] Review the self-review checklist to ensure the code is ready for review |
| 38 | + |
| 39 | +</details> |
| 40 | + |
| 41 | +<!-- |
| 42 | +
|
| 43 | +🎩 Magic happens when you code. Keep the spells flowing! |
| 44 | +
|
| 45 | +--> |
0 commit comments