From c0a4cf297d40f950df482b92af1ff8cbfe6d75ee Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Wed, 6 Mar 2019 15:52:12 -0500 Subject: [PATCH] add '_facts' rule to module checklist (#53359) * add '_facts' rule to module checklist * Update docs/docsite/rst/dev_guide/developing_modules_checklist.rst Co-Authored-By: bcoca --- docs/docsite/rst/dev_guide/developing_modules_checklist.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst index 5c0e362d9cb..52573b0a4a0 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst @@ -24,6 +24,7 @@ To contribute a module to Ansible, you must: * minimize module dependencies * support :ref:`check_mode ` if possible * ensure your code is readable +* if a module is named `_facts`, it is because it is returning `ansible_facts`. Do not name modules that do not do this with `_facts`. Please make sure your module meets these requirements before you submit your PR/proposal. If you have questions, reach out via `Ansible's IRC chat channel `_ or the `Ansible development mailing list `_.