docs/src/issue-reporting.rst
**************************
Issue Reporting Guidelines
**************************
To maintain an effective bugfix workflow and make sure issues will be solved in a timely manner we kindly ask reporters to follow some simple guidelines.
Before creating an issue, please do the following:
* Check this documentation for a solution to your problem
* Check the :github:`existing issues <issues>` to make sure you are not duplicating somebody’s work.
Issue Templates
===============
We have two different issue templates:
* :github-source:`Bug Report Template <.github/ISSUE_TEMPLATE/bug-report.md>`
* :github-source:`Feature Request Template <.github/ISSUE_TEMPLATE/feature-request.md>`
Bug Report
==========
If you are sure that the behaviour you are experiencing is really a bug (not a feature), :github:`report a new bug <issues/new?template=bug-report.md>` in the Github issue tracker following the recommendations below.
Please note, that higher level of detail in the report increases chance that someone will be able to reproduce the issue.
Describe the Bug
----------------
A clear and concise description of what the bug is.
Steps to Reproduce
------------------
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Expected Behavior
-----------------
A clear and concise description of what you expected to happen.
Actual Behavior
---------------
A clear and concise description of what actually happened.
Additional Information
----------------------
Add any other context (e.g. logs, screenshots, etc.) about the problem here.
Feature Request
===============
If you are sure the feature you want to propose doesn't already exist, :github:`request a new feature <issues/new?template=feature-request.md>` in the Github issue tracker following the recommendations below.
Motivation
----------
A clear and concise description of what the motivation for the new feature is, and what problem it is solving.
Proposed Solution
-----------------
A clear and concise description of the feature you would like to add, and how it solves the motivating problem.
Alternatives
------------
A clear and concise description of any alternative solutions or features you've considered, and why you're proposed solution is better.
Additional Context
------------------
Add any other context or screenshots about the feature request here.