|
| 1 | +--- |
| 2 | +name: First Timers Only Issue |
| 3 | +about: Create an issue to welcome a new contributor into the community. |
| 4 | +title: '' |
| 5 | +labels: first-timers-only |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## Background |
| 11 | + |
| 12 | +Overview of your issue here. |
| 13 | + |
| 14 | +## Instructions |
| 15 | +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**. |
| 16 | + |
| 17 | +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! |
| 18 | + |
| 19 | +We know that creating a pull request is the biggest barrier for new contributors. This issue is for you 💝 |
| 20 | + |
| 21 | +If you have contributed before, **consider leaving this PR for someone new**, and looking through our general [bug](https://github.com/ros-planning/moveit/labels/bug) issues. Thanks! |
| 22 | + |
| 23 | +### 🤔 What you will need to know. |
| 24 | + |
| 25 | +Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process. |
| 26 | + |
| 27 | +### 📋 Step by Step |
| 28 | + |
| 29 | +- [ ] 🙋 **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! |
| 30 | + |
| 31 | +- [ ] 🗄️**Create a local workspace** for making your changes and testing [follwing these instructions](https://moveit.ros.org/install/source/) |
| 32 | + |
| 33 | +- [ ] 📝 **Update** the file(s) `$FILENAME`by applying the change shown in the diff below. |
| 34 | + |
| 35 | +```diff |
| 36 | +$DIFF |
| 37 | +``` |
| 38 | + |
| 39 | +- [ ] 🤖 **Apply `clang-format-10`** auto formatting, [following these instructions](https://moveit.ros.org//documentation/contributing/code/?#clang-format-auto-code-formatting) |
| 40 | + |
| 41 | +- [ ] 💾 **Commit** your changes |
| 42 | + |
| 43 | +- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request: |
| 44 | +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. |
| 45 | +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. |
| 46 | + |
| 47 | +- [ ] 🏁 **Done** Ask in comments for a review :) |
| 48 | + |
| 49 | +### Is someone else already working on this? |
| 50 | + |
| 51 | +🔗- 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. |
| 52 | + |
| 53 | +👥- **If someone seems stuck, offer them some help!** |
| 54 | + |
| 55 | +### 🤔❓ Questions? |
| 56 | + |
| 57 | +Don’t hesitate to ask questions or to get help if you feel like you are getting stuck. For example leave a comment below! |
| 58 | +Furthermore, you find helpful resources here: |
| 59 | +* [MoveIt FAQ](https://moveit.ros.org/documentation/faqs/) |
| 60 | +* [MoveIt Tutorials](https://ros-planning.github.io/moveit_tutorials/) |
| 61 | +* [MoveIt contribution guide](https://moveit.ros.org/documentation/contributing/) |
| 62 | +* [ROS Tutorials](https://wiki.ros.org/ROS/Tutorials) |
| 63 | +* [ROS Answers](https://answers.ros.org/questions/) |
| 64 | + |
| 65 | +**Good luck with your first issue!** |
0 commit comments