Skip to content

Commit 3bf219b

Browse files
jaron-ljaron-l
authored
Copy over GitHub templates from ros2_control (ros-controls#228)
* docs: 📝 Port over ros2_control GitHub templates * This first commit is an exact copy. Next commit will be any changes to adapt to ros2_controllers * docs: 📝 Convert ros2_control references to ros2_controller
1 parent 33bfe46 commit 3bf219b

File tree

4 files changed

+138
-0
lines changed

4 files changed

+138
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Version [e.g. Foxy]
29+
- Anything that may be unusual about your environment
30+
31+
**Additional context**
32+
Add any other context about the problem here, especially include any modifications to any ros2_controllers that relate to this issue.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/good-first-issue.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Good first issue
3+
about: Create an issue to welcome a new contributor into the community.
4+
title: ''
5+
labels: good-first-issue
6+
assignees: ''
7+
8+
---
9+
10+
## Background
11+
12+
Overview of your issue here.
13+
14+
## Instructions
15+
Hi, this is a `good-first-issue` 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-controls/ros2_controllers/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 [following these instructions](https://docs.ros.org/en/foxy/Tutorials/Workspace/Creating-A-Workspace.html), for Step3 use "Download Source Code" section with [these instructions](https://ros-controls.github.io/control.ros.org/getting_started.html#compiling).
32+
33+
- [ ] 🍴 **Fork the repository** using the handy button at the top of the repository page and **clone** it into `~/ws_ros2_control/src/ros-controls/ros2_controllers`, [here is a guide that you can follow](https://guides.github.com/activities/forking/) (You will have to remove or empty the existing `ros2_controllers` folder before cloning your own fork)
34+
35+
- [ ] **Checkout a new branch** using `git checkout -b <branch_name>`
36+
37+
- [ ] 🤖 **Apply `pre-commit`** auto formatting, by running `pip3 install pre-commit` and running `pre-commit install` in the ros2_control repo.
38+
39+
- [ ] 💾 **Commit and Push** your changes
40+
41+
- [ ] 🔀 **Start a Pull Request** to request to merge your code into `master`. There are two ways that you can start a pull request:
42+
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.
43+
44+
- [ ] 🏁 **Done** Ask in comments for a review :)
45+
46+
### Is someone else already working on this?
47+
48+
🔗- 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.
49+
50+
👥- **If someone seems stuck, offer them some help!**
51+
52+
### 🤔❓ Questions?
53+
54+
Don’t hesitate to ask questions or to get help if you feel like you are getting stuck. For example leave a comment below!
55+
Furthermore, you find helpful resources here:
56+
* [ROS2 Control Contribution Guide](https://ros-controls.github.io/control.ros.org/contributing.html)
57+
* [ROS2 Tutorials](https://docs.ros.org/en/foxy/Tutorials.html)
58+
* [ROS Answers](https://answers.ros.org/questions/)
59+
60+
**Good luck with your first issue!**

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
---
3+
name: Pull request
4+
about: Create a pull request
5+
title: ''
6+
labels: ''
7+
assignees: ''
8+
9+
---
10+
11+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
12+
13+
1. Limited scope. Your PR should do one thing or one set of things. Avoid adding “random fixes” to PRs. Put those on separate PRs.
14+
2. Give your PR a descriptive title. Add a short summary, if required.
15+
3. Make sure the pipeline is green.
16+
4. Don’t be afraid to request reviews from maintainers.
17+
5. New code = new tests. If you are adding new functionality, always make sure to add some tests exercising the code and serving as live documentation of your original intention.
18+
19+
To send us a pull request, please:
20+
21+
- [ ] Fork the repository.
22+
- [ ] Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
23+
- [ ] Ensure local tests pass. (`colcon test` and `pre-commit run` (requires you to install pre-commit by `pip3 install pre-commit`)
24+
- [ ] Commit to your fork using clear commit messages.
25+
- [ ] Send a pull request, answering any default questions in the pull request interface.
26+
- [ ] Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

0 commit comments

Comments
 (0)