From ed0aabe02d6d06f08174b37001336ee75ebe1c9e Mon Sep 17 00:00:00 2001 From: John R Barker Date: Fri, 30 Jun 2017 20:16:26 +0100 Subject: [PATCH] Tell people to look for an existing module PR (#26287) * Tell people to look for an existing module PR There are a number of different ways to find existing PRs that add new modules. Tell people about them to potentially avoid duplicates. * Light edits --- .../docsite/rst/dev_guide/developing_modules.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules.rst b/docs/docsite/rst/dev_guide/developing_modules.rst index 435eda6bb3..9b6cc083a1 100644 --- a/docs/docsite/rst/dev_guide/developing_modules.rst +++ b/docs/docsite/rst/dev_guide/developing_modules.rst @@ -31,15 +31,25 @@ develop a module. Ask the following questions: 1. Does a similar module already exist? -There are a lot of existing modules available, and more that are in development. You should check out the list of existing modules at :doc:`../modules` or look at the `module PRs `_ for the ansible repository on Github to see if a module that does what you want exists or is in development. +There are a lot of existing modules available, you should check out the list of existing modules at :doc:`../modules` -2. Should you use or develop an action plugin instead? +2. Has someone already worked on a similar Pull Request? + +It's possible that someone has already started developing a similar PR. There are a few ways to find open module Pull Requests: + +* `GitHub new module PRs `_ +* `All updates to modules `_ +* `New module PRs listed by directory `_ search for `lib/ansible/modules/` + +If you find an existing PR that looks like it addresses the issue you are trying to solve, please provide feedback on the PR - this will speed up getting the PR merged. + +3. Should you use or develop an action plugin instead? Action plugins get run on the master instead of on the target. For modules like file/copy/template, some of the work needs to be done on the master before the module executes on the target. Action plugins execute first on the master and can then execute the normal module on the target if necessary. For more information about action plugins, `read the action plugins documentation here `_. -3. Should you use a role instead? +4. Should you use a role instead? Check out the roles documentation `available here `_.