From 4057cc6c28d4cd9ffa5b98f6872bbab6973b64f7 Mon Sep 17 00:00:00 2001 From: Simon Alibert <75076266+aliberts@users.noreply.github.com> Date: Tue, 16 Apr 2024 19:35:01 +0200 Subject: [PATCH] Apply suggestions from code review Various fixes for #74 Co-authored-by: Remi --- .github/ISSUE_TEMPLATE/bug-report.yml | 17 ++++------------- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- CONTRIBUTING.md | 8 ++++---- 3 files changed, 12 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 98d359fe..132c21cb 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -11,7 +11,7 @@ body: id: system-info attributes: label: System Info - description: Please share your lerobot configuration with us. You can run the command `python -m lerobot.commands.env` and copy-paste its outputs below + description: If needed, you can share your lerobot configuration with us by running `python -m lerobot.commands.env` and copy-pasting its outputs below render: Shell placeholder: lerobot version, OS, python version, numpy version, torch version, and lerobot's configuration validations: @@ -22,15 +22,6 @@ body: attributes: label: Information description: 'The problem arises when using:' - options: - - label: "The official example scripts" - - label: "My own modified scripts" - - - type: checkboxes - id: information-tasks - attributes: - label: Tasks - description: "The tasks I am working on are:" options: - label: "One of the scripts in the examples/ folder of LeRobot" - label: "My own task or dataset (give details below)" @@ -42,10 +33,10 @@ body: attributes: label: Reproduction description: | - Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. - If you have code snippets, error messages, stack traces please provide them here as well. + If needed, provide a simple code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. + Sharing error messages or stack traces could be useful as well! Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting - Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. + Try to avoid screenshots, as they are hard to read and don't allow copy-and-pasting. placeholder: | Steps to reproduce the behavior: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7141fc0a..5084567b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,12 +4,12 @@ Example: Fixes # (issue) ## Before submitting -- [ ] Did you read the [contributor guideline](https://github.com/huggingface/lerobot/blob/main/CONTRIBUTING.md#submitting-a-pull-request-pr), Pull Request section? -- [ ] Please provide a minimal example for the reviewer to checkout & try. -- [ ] How did you test your changes? +- Read the [contributor guideline](https://github.com/huggingface/lerobot/blob/main/CONTRIBUTING.md#submitting-a-pull-request-pr). +- Provide a minimal code example for the reviewer to checkout & try. +- Explain how you tested your changes. ## 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. Please tag fewer than 3 people. +members/contributors who may be interested in your PR. Try to avoid tagging more than 3 people. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 934a7b8f..0b40d81a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ others, reaching out and improving the documentations are immensely valuable to the community. It also helps us if you spread the word: reference the library from blog posts -on the awesome projects it made possible, shout out on Twitter every time it has +on the awesome projects it made possible, shout out on Twitter when it has helped you, or simply ⭐️ the repo to say "thank you". Whichever way you choose to contribute, please be mindful to respect our @@ -16,7 +16,7 @@ Whichever way you choose to contribute, please be mindful to respect our Some of the ways you can contribute to 🤗 LeRobot: * Fixing outstanding issues with the existing code. -* Implementing new models. +* Implementing new models, datasets or simulation environments. * Contributing to the examples or to the documentation. * Submitting issues related to bugs or desired new features. @@ -57,7 +57,7 @@ A good feature request addresses the following points: about it! * Is it something you worked on and think could benefit the community? Awesome! Tell us what problem it solved for you. -2. Write a *full paragraph* describing the feature. +2. Write a *paragraph* describing the feature. 3. Provide a **code snippet** that demonstrates its future use. 4. In case this is related to a paper, please attach a link. 5. Attach any additional information (drawings, screenshots, etc.) you think may help. @@ -211,7 +211,7 @@ Follow these steps to start contributing: 2. If your pull request addresses an issue, please mention the issue number in the pull request description to make sure they are linked (and people consulting the issue know you are working on it); -3. To indicate a work in progress please prefix the title with `[WIP]`, or mark +3. To indicate a work in progress please prefix the title with `[WIP]`, or preferably mark the PR as a draft PR. These are useful to avoid duplicated work, and to differentiate it from PRs ready to be merged; 4. Make sure existing tests pass;