Bugs & Features

Development#

Pandas TA is an actively maintained and continuously evolving project. However, it maintains a low churn rate. It has occasional and untagged (development) releases to address bugs and features. With additional financial support, this library can be further improved to accommodate more indicators and features.

Before submitting an Issue!#

1. See the How to ... section for potential solutions.
2. Read and understand the Bug Report and Feature requests requirements below before submitting!

3. Lastly ...

   Personal Emails

   • Serious business inquires only.
   • Bugs, Issues or Feature Requests are only dealt through support@pandas-ta.dev

Bug Report#

This is a large library with over a hundred indicators and a Pandas DataFrame Extension to manage. Every attempt is made to minimize bugs and return accurate and fast computations. However bugs occur and reporting is frequently duplicitous. Development and testing take considerable time without knowledgable, serious, and frequent contributions.

Upgrade to the Latest Version#

There is a high chance that the bug you have encountered was already fixed in subsequent version. Hence, before reporting an issue, ensure that you're running the latest version.

Solution Search#

Before spending time on creating a bug report that responds with link(s) to relevant documentation or another already reported or closed issue, et al. You can save everyone time by doing some research:

1. Search the documentation and look for relevant sections that could be related to your issue. If found, double check your code.
2. Search the internet.

Description#

Provide a clear, focused, specific and concise summary of the bug encountered. Explain why you consider it a bug of this library and not one of it's dependencies.

Please adhere to the following principles:

• Explain the what and not the how - No need to explain the how to reproduce the issue here (that's later). Focus on clearly explaining what happened as clearly as possible.
• Keep it short and concise - If the issue can be explained in one or two sentences, great! No need to expand any more.
• One bug at a time - If several unrelated issues occur, create seperate issues for them. Do not report them in the same issue.

Related Links#

Please share links to all sections of the documentation that might be relevant to the bug, so it can be gradually improved. This includes all links online. This helps understand the context and history of the issue.

Reproduction#

A minimal reproduction with a stack trace is required in all cases. Keep it concise and include the necessary Python packages, the installed Pandas TA version, and any relevant details. Issues that cannot be reproduced will be closed.

Report Template#

Copy and answer All of the following questions regardless of their perceived importance:

1. [ ] Description of the issue. (See above)
2. [ ] You have searched and read ALL relevant "open" and "closed" issues and "pull requests"?
3. [ ] Operating System and Version & Python Version
4. [ ] All relevant Python packages and their versions
5. [ ] You have installed and tried latest development version? Which version?
6. [ ] All related links you've used to attempt issue resolution
7. [ ] Include all the combinations of arguments/parameters tried
8. [ ] Reproducible Code with 500+ bars of csv data
9. [ ] Stack Traces
10. [ ] Screenshots
11. [ ] Additional Details
12. [ ] I understand that this bug may never be addressed or considered for inclusion into the package.

   Submit Bug

Feature and Indicator Requests#

Requesting library features or indicators is similar to filing a Bug Report.

Request Template#

Copy and answer All of the following questions regardless of their perceived importance:

1. [ ] Description of the issue. (See above)
2. [ ] All related links you've used to attempt this yourself.
3. [ ] Operating System and Version & Python Version
4. [ ] All relevant Python packages and their versions
5. [ ] You have installed and tried latest development version? Which version?
6. [ ] Reproducible Code with 500+ bars of csv data
7. [ ] Preferred Feature or Indicator Name
8. [ ] Expected Results
9. [ ] Additional Details
10. [ ] I understand that this feature may never be addressed or considered for inclusion into the package.

   Submit Feature