From d5d4d0262a758a275c20af8efea4c1d684039688 Mon Sep 17 00:00:00 2001 From: Brenden Chouinard Date: Fri, 26 Sep 2025 15:07:23 -0400 Subject: [PATCH 1/3] chore(issues): simplify Good First Issue template --- .github/ISSUE_TEMPLATE/good_first_issue.yml | 56 +++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/good_first_issue.yml diff --git a/.github/ISSUE_TEMPLATE/good_first_issue.yml b/.github/ISSUE_TEMPLATE/good_first_issue.yml new file mode 100644 index 0000000000..87a9df64b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/good_first_issue.yml @@ -0,0 +1,56 @@ +name: "Good First Issue" +description: "A small, well-scoped task for new contributors" +title: "[GFI]: " +labels: ["good first issue", "help wanted"] +assignees: [] + +body: + - type: input + id: summary + attributes: + label: Brief summary + description: One or two sentences describing the problem or task. + placeholder: "E.g., Simplify docs link in README" + validations: + required: true + + - type: textarea + id: context + attributes: + label: Context / background + description: Why this matters; where it appears (package, file path, links). + placeholder: | + - Package: moveit_core + - File: moveit_core/... + - Link: https://github.com/ros-planning/moveit2/... + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce / change details + description: Commands, screenshots, or logs if helpful. + validations: + required: false + + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + description: What must be true for "Done"? + placeholder: | + - Update to ... + - Add/adjust test ... + - CI passes + validations: + required: true + + - type: textarea + id: pointers + attributes: + label: Helpful pointers + description: Links to code, docs, examples; suggested approach. + validations: + required: false + From 6a689844193b7e78c85caecda505d278fd04f27a Mon Sep 17 00:00:00 2001 From: Ezra Brooks Date: Wed, 26 Nov 2025 08:52:49 -0500 Subject: [PATCH 2/3] Remove original template --- .github/ISSUE_TEMPLATE/first_timers_only.md | 67 --------------------- 1 file changed, 67 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/first_timers_only.md diff --git a/.github/ISSUE_TEMPLATE/first_timers_only.md b/.github/ISSUE_TEMPLATE/first_timers_only.md deleted file mode 100644 index ecd89f9455..0000000000 --- a/.github/ISSUE_TEMPLATE/first_timers_only.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -name: First Timers Only Issue -about: Create an issue to welcome a new contributor into the community. -title: '' -labels: first-timers-only -assignees: '' - ---- - -## Background - -Overview of your issue here. - -## Instructions -Hi, this is a `first-timer-only` issue. This means we've worked to make it more legible to people who either **haven't contributed to our codebase before, or even folks who haven't contributed to open source before**. - -We're interested in helping you take the first step, and can answer questions and help you out along the way. Note that we're especially interested in contributions from underrepresented groups! - -We know that creating a pull request is the biggest barrier for new contributors. This issue is for you πŸ’ - -If you have contributed before, **consider leaving this PR for someone new**, and looking through our general [bug](https://github.com/moveit/moveit2/labels/bug) issues. Thanks! - -### πŸ€” What you will need to know. - -Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process. - -### πŸ“‹ Step by Step - -- [ ] πŸ™‹ **Claim this issue**: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along! - -- [ ] πŸ—„οΈ **Create a local workspace** for making your changes and testing [following these instructions](https://moveit.ros.org/install/source/) - -- [ ] 🍴 **Fork the repository** using the handy button at the top of the repository page and **clone** it into `~/ws_moveit/src/moveit`, [here is a guide that you can follow](https://guides.github.com/activities/forking/) (You will have to remove or empty the existing `moveit` folder before cloning your own fork) - -- [ ] πŸ“ **Update** the file(s) `$FILENAME`by applying the change shown in the diff below. - -```diff -$DIFF -``` - -- [ ] πŸ€– **Apply `clang-format-14`** auto formatting, [following these instructions](https://moveit.picknik.ai/main/doc/how_to_contribute/how_to_contribute_to_site.html) - -- [ ] πŸ’Ύ **Commit and Push** your changes - -- [ ] πŸ”€ **Start a Pull Request** to request to merge your code into `master`. There are two ways that you can start a pull request: -1. If you are not familiar with GitHub or how to create a pull request, [here is a guide you can follow](https://guides.github.com/activities/hello-world/) on how GitHub works. -2. If you are familiar with the terminal or would like to learn to use it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal. - -- [ ] 🏁 **Done** Ask in comments for a review :) - -### Is someone else already working on this? - -πŸ”—- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it. - -πŸ‘₯- **If someone seems stuck, offer them some help!** - -### πŸ€”β“ Questions? - -Don’t hesitate to ask questions or to get help if you feel like you are getting stuck. For example leave a comment below! -Furthermore, you find helpful resources here: -* [MoveIt FAQ](https://moveit.ros.org/documentation/faqs/) -* [MoveIt Tutorials](https://moveit.picknik.ai/main/doc/tutorials/tutorials.html) -* [MoveIt contribution guide](https://moveit.picknik.ai/main/doc/how_to_contribute/how_to_contribute.html) -* [ROS Tutorials](https://wiki.ros.org/ROS/Tutorials) -* [ROS Answers](https://answers.ros.org/questions/) - -**Good luck with your first issue!** From 599d8767b8b24f2f34a228df2a58a2c55fe4f22a Mon Sep 17 00:00:00 2001 From: Ezra Brooks Date: Wed, 26 Nov 2025 08:57:42 -0500 Subject: [PATCH 3/3] Fix format --- .github/ISSUE_TEMPLATE/good_first_issue.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/good_first_issue.yml b/.github/ISSUE_TEMPLATE/good_first_issue.yml index 87a9df64b0..da8d032592 100644 --- a/.github/ISSUE_TEMPLATE/good_first_issue.yml +++ b/.github/ISSUE_TEMPLATE/good_first_issue.yml @@ -53,4 +53,3 @@ body: description: Links to code, docs, examples; suggested approach. validations: required: false -