Sugestions and bug report

Any suggestion or bug found, please report in this repository issues using the feature request (for new features), documentation request (to request, add or correct documentation) or bug report (to report bugs) template. Also notify the maintainer (Rodolfo Dirack) by email:

rodolfo_profissional@hotmail.com

When reporting a bug please explain in which situation it was found, to allow the reproducing process of the bug, the program version, your system version (OS) and all the relevant information.

When proposing a suggestion is also important to maintain the same level of clarity about which goal you are trying to achieve with this (new feature, code enhancement, etc), the program version which this suggestion applies, and evaluate if this suggestion was not satisfied or proposed in a previous version.

Examples of issues templates available

There are standard issues in this repository to make suggestions and to report bugs. Please follow the examples bellow accordingly to your request:

Example of a new "feature request"

The feature requests are the way you can ask for a new feature to be build by the maintainer or other developer (including you). First, fill in the title of your feature request, starting with the label [FEA], and fill in the form. When finished, your feature request should look like that example bellow:

[FEA] The title of my feature request

🎉 Feature request

Is your feature request related to a problem? Please describe.

Right here I described my feature request and its purpose...

Describe the solution you'd like

Here I described the way I am thinking to solve this problem...

Describe alternatives you've considered

Here I describe any alternative solutions or features I've considered...

Additional context

Here I add any other context or screenshots about the feature request...

---

Example of a new "documentation request"

The documentation request is the way you ask for a new documentation document or to ask for a documentation correction. First, fill in the title of your documentation request, starting with the label [DOC], and fill in the form. When finished, your feature request should look like that example bellow:

[DOC] The title of my documentation request

Documentation request

Describe your documentation request clearly bellow

Here I describe my documentation request...

Program version

The version of the package I am asking for documentation...

What kind of documentation you are requesting?

• README files.
• Wiki pages.
• Jupyter notebooks.
• Other

---

Example of a new "bug report"

The bug report is the way you report the bugs of the software available in this repository. First, fill in the title of your documentation request, starting with the label [BUG], and fill in the form. When finished, your bug report should look like that example bellow:

[BUG] The title of my bug report

🐛 Bug report

Describe the bug

Here I describe the bug...

To Reproduce

Here I describe the steps to reproduce the bug...

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior

Here I describe the way I am expecting the program should behave...

A clear and concise description of what you expected to happen.

Screenshots

If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Version [e.g. 22]

Additional context

Here I add any other context about the problem...