ansible / ansible-lint

ansible-lint checks playbooks for practices and behavior that could potentially be improved and can fix some of the most common ones for you
https://ansible.readthedocs.io/projects/lint/
GNU General Public License v3.0
3.5k stars 664 forks source link

name[imperative]: All task names should be written in the imperative #2170

Open cidrblock opened 2 years ago

cidrblock commented 2 years ago

Starting to pull in possible rule ideas from the community of practice: https://github.com/redhat-cop/automation-good-practices/pull/64

A task in a task file or play performs an action, the name of the task should be written in the imperative.

We might need to pull this one and use some internals rather than maintain an internal list:

https://github.com/PyCQA/pydocstyle/blob/master/src/pydocstyle/data/imperatives.txt

ssbarnea commented 2 years ago

Are we ok to add pydocstyle as a dependency for the linter? Do we have any other python library that can help us achieve the same goal?