ansible/docs/docsite/rst/community/reporting_bugs_and_features...


.. _reporting_bugs_and_features:

**************************************
Reporting bugs and requesting features
**************************************

.. contents::
   :local:

.. _reporting_bugs:

Reporting a bug
===============

Security bugs
-------------

Ansible practices responsible disclosure. To report security-related bugs, send an email to  `security@ansible.com <mailto:security@ansible.com>`_ for an immediate response. Do not submit a  ticket or post to any public groups.

Bugs in ansible-core
--------------------

Before reporting a bug, search in GitHub for `already reported issues <https://github.com/ansible/ansible/issues>`_ and `open pull requests <https://github.com/ansible/ansible/pulls>`_ to see if someone has already addressed your issue.  Unsure if you found a bug? Report the behavior on the :ref:`mailing list or community chat first <communication>`.

Also, use the mailing list or chat to discuss whether the problem is in ``ansible-core`` or a collection, and for "how do I do this" type questions.

You need a free GitHub account to `report bugs <https://github.com/ansible/ansible/issues>`_ that affect:

- multiple plugins  
- a plugin that remained in the ansible/ansible repo  
- the overall functioning of Ansible  

How to write a good bug report
------------------------------

If you find a bug, open an issue using the `issue template <https://github.com/ansible/ansible/issues/new?assignees=&labels=&template=bug_report.yml>`_. 

Fill out the issue template as completely and as accurately as possible. Include:

* your Ansible version
* the expected behavior and what you've tried, including the exact commands you were using or tasks you are running.
* the current behavior and why you think it is a bug
* the steps to reproduce the bug 
* a minimal reproducible example and comments describing examples
* any relevant configurations and the components you used
* any relevant output plus ``ansible -vvvv`` (debugging) output
* add the output of ``ansible-test-env --show`` when filing bug reports involving ``ansible-test``. 

When sharing YAML in playbooks, ensure that you preserve formatting using `code blocks  <https://help.github.com/articles/creating-and-highlighting-code-blocks/>`_. For multiple-file content, use gist.github.com, more durable than Pastebin content.

.. _request_features:

Requesting a feature
====================

Before you request a feature, check what is :ref:`planned for future Ansible Releases <roadmaps>`. Check `existing pull requests tagged with feature <https://github.com/ansible/ansible/issues?q=is%3Aissue+is%3Aopen+label%3Afeature>`_.

To get your feature into Ansible, :ref:`submit a pull request <community_pull_requests>`, either against ansible-core or a collection. See also :ref:`ansible_collection_merge_requirements`. For ``ansible-core``, you can also open an issue in `ansible/ansible <https://github.com/ansible/ansible/issues>`_  or in a corresponding collection repository (To find the correct issue tracker, refer to :ref:`Bugs in collections<reporting_bugs_in_collections>` ).
Address Docs: How to report bugs #53520 (#77214) 3 years ago
Link fixes (#39038) * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages 7 years ago			`.. _reporting_bugs_and_features:`

Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review 7 years ago			`**************************************`
partial update of community docs to reflect collections transition (#70488) 4 years ago			`Reporting bugs and requesting features`
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review 7 years ago			`**************************************`
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index. 7 years ago
partial update of community docs to reflect collections transition (#70488) 4 years ago			`.. contents::`
			`:local:`
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review 7 years ago
Docs reorg /community/index & /dev_guide/index (#48734) * Improved community/index.rst makes it easier to find existing content 6 years ago			`.. _reporting_bugs:`

Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 6 years ago			`Reporting a bug`
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review 7 years ago			`===============`
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index. 7 years ago
partial update of community docs to reflect collections transition (#70488) 4 years ago			`Security bugs`
			`-------------`

Update reporting_bugs_and_features.rst (#77518) 3 years ago			Ansible practices responsible disclosure. To report security-related bugs, send an email to `security@ansible.com <mailto:security@ansible.com>`_ for an immediate response. Do not submit a ticket or post to any public groups.
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index. 7 years ago
Rebased pr73824 (#73934) Co-authored-by: Eugene <k.evgen61@gmail.com> Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> 4 years ago			`Bugs in ansible-core`
partial update of community docs to reflect collections transition (#70488) 4 years ago			`--------------------`

Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago			Before reporting a bug, search in GitHub for `already reported issues <https://github.com/ansible/ansible/issues>`_ and `open pull requests <https://github.com/ansible/ansible/pulls>`_ to see if someone has already addressed your issue. Unsure if you found a bug? Report the behavior on the :ref:`mailing list or community chat first <communication>`.
Address Docs: How to report bugs #53520 (#77214) 3 years ago
Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago			Also, use the mailing list or chat to discuss whether the problem is in ``ansible-core`` or a collection, and for "how do I do this" type questions.
Address Docs: How to report bugs #53520 (#77214) 3 years ago
Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago			You need a free GitHub account to `report bugs <https://github.com/ansible/ansible/issues>`_ that affect:

			`- multiple plugins`
			`- a plugin that remained in the ansible/ansible repo`
			`- the overall functioning of Ansible`
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index. 7 years ago
Address Docs: How to report bugs #53520 (#77214) 3 years ago			`How to write a good bug report`
			`------------------------------`
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used. 7 years ago
Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago			If you find a bug, open an issue using the `issue template <https://github.com/ansible/ansible/issues/new?assignees=&labels=&template=bug_report.yml>`_.

			`Fill out the issue template as completely and as accurately as possible. Include:`
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used. 7 years ago
Fix list formatting (#77354) 3 years ago			`* your Ansible version`
Update reporting_bugs_and_features.rst (#77518) 3 years ago			`* the expected behavior and what you've tried, including the exact commands you were using or tasks you are running.`
Fix list formatting (#77354) 3 years ago			`* the current behavior and why you think it is a bug`
			`* the steps to reproduce the bug`
			`* a minimal reproducible example and comments describing examples`
			`* any relevant configurations and the components you used`
			* any relevant output plus ``ansible -vvvv`` (debugging) output
Update reporting_bugs_and_features.rst (#77518) 3 years ago			* add the output of ``ansible-test-env --show`` when filing bug reports involving ``ansible-test``.
Fix list formatting (#77354) 3 years ago
Update reporting_bugs_and_features.rst (#77518) 3 years ago			When sharing YAML in playbooks, ensure that you preserve formatting using `code blocks <https://help.github.com/articles/creating-and-highlighting-code-blocks/>`_. For multiple-file content, use gist.github.com, more durable than Pastebin content.
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used. 7 years ago
Docs reorg /community/index & /dev_guide/index (#48734) * Improved community/index.rst makes it easier to find existing content 6 years ago			`.. _request_features:`

New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used. 7 years ago			`Requesting a feature`
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review 7 years ago			`====================`
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used. 7 years ago
Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago			Before you request a feature, check what is :ref:`planned for future Ansible Releases <roadmaps>`. Check `existing pull requests tagged with feature <https://github.com/ansible/ansible/issues?q=is%3Aissue+is%3Aopen+label%3Afeature>`_.
Docsite: improve reporting_bugs_and_features.rst (#75234) * Docsite: improve reporting_bugs_and_features.rst * Add clarification 3 years ago
Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago			To get your feature into Ansible, :ref:`submit a pull request <community_pull_requests>`, either against ansible-core or a collection. See also :ref:`ansible_collection_merge_requirements`. For ``ansible-core``, you can also open an issue in `ansible/ansible <https://github.com/ansible/ansible/issues>`_ or in a corresponding collection repository (To find the correct issue tracker, refer to :ref:`Bugs in collections<reporting_bugs_in_collections>` ).