From 292da1f4feedad6b1792a4be13c5432d87d28277 Mon Sep 17 00:00:00 2001 From: Simon Alibert Date: Sat, 4 May 2024 20:15:48 +0200 Subject: [PATCH] Enhance PR template --- .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a9b733d4..c0e754f0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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: -- Fixes # (issue) -- Adds new dataset -- Optimizes something +| Title | Label | +|----------------------|-----------------| +| 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: - Added `test_something` in `tests/test_stuff.py`. @@ -13,6 +17,7 @@ Examples: - Optimized `some_function`, it now runs X times faster than previously. ## How to checkout & try? (for the reviewer) +Provide a simple way for the reviewer to try out your changes. Examples: ```bash @@ -27,6 +32,5 @@ Please read the [contributor guideline](https://github.com/huggingface/lerobot/b ## Who can review? - 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.