Skip to content

DRAFT README.md #533

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

Draft
wants to merge 6 commits into
base: rolling
Choose a base branch
from
Draft

DRAFT README.md #533

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f14163f
Add README.md
Nils-ChristianIseke Mar 21, 2025
76eabc9
Update README.md
Nils-ChristianIseke Mar 24, 2025
325a507
Update README.md
Nils-ChristianIseke Mar 24, 2025
6d3d41b
Update README.md
Nils-ChristianIseke Mar 24, 2025
1d07872
Update README.md
Nils-ChristianIseke Mar 24, 2025
2b4e591
updating readme
Nils-ChristianIseke Apr 14, 2025
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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
ament_lint contains a number of packages that perform linting tasks. Those linters can be used both from the command line and from CMake.
## ament_lint

ament_lint contains a number of packages, each package wraps a linter into an ament_$linter CLI tool, which is then wrapped in CMake (ament_cmake_$linter)
Those linters can be used both from the command line and from CMake.
Copy link
Member

@christophebedard christophebedard Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They also have a Python API, e.g., here:

ament_lint/ament_mypy/ament_mypy/main.py

Line 30 in 2bee915

def main(argv: List[str] = sys.argv[1:]) -> int:
. This can be called in a test, e.g., here: https://github.com/ros2/launch/blob/f8ef67a0f8cface863e1cd168f0b6bf2976be60b/launch/test/test_mypy.py#L22.

The tools are configured to meet [ROS 2 coding standards](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Code-Style-Language-Versions.html).
It bundles common linting tools with ROS 2-specific wrappers to ensure consistent functionality across packages.
Fore more information regarding ament_lint see [here](https://docs.ros.org/en/rolling/Tutorials/Advanced/Ament-Lint-For-Clean-Code.html).
For information on each ament tool, refer to the documentation in their package's doc/ directory.

## Contributing

The tool argument are still being refined — some features from standalone linters may not yet work perfectly. We welcome contributions to improve:
We welcome contributions to improve:
- Linter arguments
- Additional tool support
- ...
Please follow the [Contrubution Guidelines](CONTRIBUTING.md).

Please follow the [Contribution Guidelines](CONTRIBUTING.md).