1.. _reporting_bugs_and_features:
2
3**************************************
4Reporting bugs and requesting features
5**************************************
6
7.. contents::
8   :local:
9
10.. _reporting_bugs:
11
12Reporting a bug
13===============
14
15Security bugs
16-------------
17
18Ansible practices responsible disclosure - if this is a security-related bug, email `security@ansible.com <mailto:security@ansible.com>`_ instead of filing a ticket or posting to any public groups, and you will receive a prompt response.
19
20Bugs in ansible-base
21--------------------
22
23If you find a bug that affects multiple plugins, a plugin that remained in the ansible/ansible repo, or the overall functioning of Ansible, report it to `github.com/ansible/ansible/issues <https://github.com/ansible/ansible/issues>`_. You need a free GitHub account.  Before reporting a bug, use the bug/issue search to see if the issue has already been reported. If you are not sure if something is a bug yet, you can report the behavior on the :ref:`mailing list or IRC first <communication>`.
24
25Do not open issues for "how do I do this" type questions.  These are great topics for IRC or the mailing list, where things are likely to be more of a discussion.
26
27If you find a bug, open the issue yourself to ensure we have a record of it. Do not rely on someone else in the community to file the bug report for you. We have created an issue template, which saves time and helps us help everyone with their issues more quickly. Please fill it out as completely and as accurately as possible:
28
29  * Include the Ansible version
30  * Include any relevant configuration
31  * Include the exact commands or tasks you are running
32  * Describe the behavior you expected
33  * Provide steps to reproduce the bug
34    * Use minimal well-reduced and well-commented examples, not your entire production playbook
35    * When sharing YAML in playbooks, preserve the formatting by using `code blocks  <https://help.github.com/articles/creating-and-highlighting-code-blocks/>`_.
36  * Document the behavior you got
37  * Include output where possible
38  * For multiple-file content, use gist.github.com, which is more durable than pastebin content
39
40Bugs in collections
41-------------------
42
43Many bugs only affect a single module or plugin. If you find a bug that affects a module or plugin hosted in a collection, file the bug in the repository of the :ref:`collection <collections>`:
44
45  #. Find the collection on Galaxy.
46  #. Click on the Issue Tracker link for that collection.
47  #. Follow the contributor guidelines or instructions in the collection repo.
48
49If you are not sure whether a bug is in ansible-base or in a collection, you can report the behavior on the :ref:`mailing list or IRC first <communication>`.
50
51.. _request_features:
52
53Requesting a feature
54====================
55
56The best way to get a feature into Ansible is to :ref:`submit a pull request <community_pull_requests>`, either against ansible-base or against a collection. See also :ref:`ansible_collection_merge_requirements`.
57