Revision: "Address Docs: How to report bugs" #53520 (#77269)

pull/77196/merge
Christian Adamini 3 years ago committed by GitHub
parent 1bdcb56249
commit fa12af9042
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -16,16 +16,17 @@ Reporting a bug
Security bugs
-------------
Ansible 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 to receive a prompt response.
Ansible practices responsible disclosure - for security-related bugs, email `security@ansible.com <mailto:security@ansible.com>`_ to receive a prompt response. Do not submit a ticket or post to any public groups.
Bugs in ansible-core
--------------------
Before reporting a bug, use the bug/issue search to check for `already reported issues <https://github.com/ansible/ansible/issues>`. Unsure if you found a bug? Report the behavior on the :ref:`mailing list or community chat first <communication>`.
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 if you are unsure whether a bug is in ``ansible-core`` or in a collection, and for "how do I do this" type questions to discuss.
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:
You need a free GitHub account to `report bugs <https://github.com/ansible/ansible/issues>`_ that affects
- multiple plugins
- a plugin that remained in the ansible/ansible repo
- the overall functioning of Ansible
@ -33,18 +34,19 @@ You need a free GitHub account to `report bugs <https://github.com/ansible/ansib
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>`. Detail what you've tried, why you think this is a bug, and what component to use. Fill it out as completely and as accurately as possible, include:
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
* any relevant configurations
* the exact commands or tasks you are running
* the expected behavior
* the current behavior and why you think it is a bug
* what you've tried including the exact commands you were using or tasks you are running
* any relevant configurations and the components you used
* any relevant output plus ``ansible -vvvv`` (debugging) output
* the steps to reproduce the bug
* Use a minimal reproducible example and comments describing examples
* Preserve formatting using `code blocks <https://help.github.com/articles/creating-and-highlighting-code-blocks/>`_ when sharing YAML in playbooks.
* the behavior you currently see
* output where possible
* ``ansible -vvvv`` (debugging) output
For multiple-file content, use gist.github.com, which is more durable than pastebin content.
@ -53,7 +55,6 @@ For multiple-file content, use gist.github.com, which is more durable than paste
Requesting a feature
====================
Before you request a feature, check what is :ref:`planned for future Ansible Releases <roadmaps>`.
To get your feature into Ansible, :ref:`submit a pull request <community_pull_requests>`, either against ansible-core or against a collection. See also :ref:`ansible_collection_merge_requirements`. To check already submitted pull requests, refer to :ref: `existing pull requests tagged with feature <https://github.com/ansible/ansible/issues?q=is%3Aissue+is%3Aopen+label%3Afeature>`.
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>`_.
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 learn how to find a proper issue tracker, refer to :ref:`Bugs in collections<reporting_bugs_in_collections>` section ).
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>` ).

Loading…
Cancel
Save