Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix the contribution recommendation to use rosdistro_reformat with a tool that exists and works #37232

Merged
merged 1 commit into from
May 16, 2023
Merged

Fix the contribution recommendation to use rosdistro_reformat with a tool that exists and works #37232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,12 @@ These tests require several dependencies that can be installed either from the R
| unidiff | python-unidiff (Zesty and higher) | unidiff |
| yamllint | yamllint | yamllint |

There is a tool ``rosdistro_reformat`` which will fix most formatting errors such as alphabetization and correct formatting.
There is a tool [scripts/check_rosdep](./scripts/check_rosdep.py) which will check most formatting errors such as alphabetization and correct formatting.
It is recommended to run it before submitting your contribution.

For example, to check a change to `rosdep/base.yaml`:
```bash
python3 scripts/check_rosdep.py rosdep/base.yaml
```

Note: There's a [known issue](https://github.com/disqus/nose-unittest/issues/2) discovered [here](https://github.com/ros/rosdistro/issues/16336) that most tests won't run if you have the python package `nose-unitttest` installed.