wangzixiang
/
lerobot
mirror of https://github.com/huggingface/lerobot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Enhance PR template

This commit is contained in:
Simon Alibert 2024-05-04 20:15:48 +02:00
parent 649087a274
commit 292da1f4fe
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,11 +1,15 @@
# What does this PR do? ## What this does
Explain what does this PR do. Feel free to tag your PR with the appropriate label(s).
Examples: Examples:
- Fixes # (issue) | Title | Label |
- Adds new dataset |----------------------|-----------------|
- Optimizes something | Fixes #[issue] | (🐛 Bug) |
| Adds new dataset | (🗃️ Dataset) |
| Optimizes something | (⚡️ Performance) |
## How was it tested? ## How it was tested
Explain/show how you tested your changes.
Examples: Examples:
- Added `test_something` in `tests/test_stuff.py`. - Added `test_something` in `tests/test_stuff.py`.
@ -13,6 +17,7 @@ Examples:
- Optimized `some_function`, it now runs X times faster than previously. - Optimized `some_function`, it now runs X times faster than previously.
## How to checkout & try? (for the reviewer) ## How to checkout & try? (for the reviewer)
Provide a simple way for the reviewer to try out your changes.
Examples: Examples:
```bash ```bash
@ -27,6 +32,5 @@ Please read the [contributor guideline](https://github.com/huggingface/lerobot/b
## Who can review? ## Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR. Try to avoid tagging more than 3 people. members/contributors who may be interested in your PR. Try to avoid tagging more than 3 people.