Skip to content

Commit 8806080

Browse files
Fix PR template (#265)
* Fix PR template * Fix links * Add info to local tests
1 parent f3caa81 commit 8806080

File tree

2 files changed

+10
-18
lines changed

2 files changed

+10
-18
lines changed
Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
---
32
name: Pull request
43
about: Create a pull request
@@ -7,20 +6,13 @@ labels: ''
76
assignees: ''
87

98
---
9+
## General
10+
Please consider the infos from [CONTRIBUTING.md](CONTRIBUTING.md) before you open a pull request.
11+
## New Examples
12+
If you propose addign a new example, make sure that your new example has:
1013

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.
14+
- [ ] The correct folder structure (described in the main [README.md](README.md))
15+
- [ ] Example has *doc/README.rst* with description
16+
- [ ] Detailed commands how to run an example
17+
- [ ] Output examples of CLI commands
18+
- [ ] Screenshots with expected visualizations (if applicable)

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To send us a pull request, please:
3333
1. Fork the repository.
3434
2. Modify the source; please focus on the specific change you are contributing.
3535
If you also reformat all the code, it will be hard for us to focus on your change.
36-
3. Ensure local tests pass.
36+
3. Ensure local tests pass: `colcon test` and `pre-commit run` (requires you to install pre-commit by `pip3 install pre-commit`).
3737
4. Commit to your fork using clear commit messages.
3838
5. Send a pull request, answering any default questions in the pull request interface.
3939
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

0 commit comments

Comments
 (0)