Contributions:
Checkout:
Contributing guidelines
For submitting a pull request:
Checkout:
Pull Request Template
tsauditor encourages contributions of all types, including:
Documentation
Right now, tsauditor is in its fairly early stages and lacks extensive documentation apart from the docstrings at the beginning of each .py file. To contribute to documentation, enhance the docstrings by adding concise details for each code snippet.
Example notebooks
An example notebook highlighting different use cases for tsauditor. [EXAMPLE] Adding Example notebooks for a use case) has some good starting points for proposing an example notebook.
Test Cases
Adding test cases for general and various edge cases. [TEST] Add edge-case tests for single-row DataFrames and [TEST] Add edge-case tests for all-NaN columns are for edge cases. While, [TEST] Adding more types of tests for use cases is for adding general test cases.
Enhancements
To add an enhancement, open an issue with the enhancement label, if you wish to contribute, submit a pull request and you are good to go! Make sure your enhancement passes the already present tests. [ENH] Propose default thresholds for a domain="crypto" preset is an enhancement issue. Though it requires domain knowledge.
Bug Reporting
Got something the library should do, but doesn't? Or do you have a specific data misfiring in mind? Open an issue with the label bug, follow the guidelines in Bug Reporting
Feature Request
Library should do something an existing python or R package does but doesn't? Got another idea? feel free to discuss in the discussions tab or shoot a shot with Request a feature
Things to keep in mind:
Don't forget to run a ruff check
Make sure your code is PEP8 compliant.
Make sure your code passes all the relevant checks
Please comment before you start working on an issue
Got a suggestion? Use the Discussions tab, I will be happy to collaborate
Contributions:
Checkout:
Contributing guidelines
For submitting a pull request:
Checkout:
Pull Request Template
tsauditorencourages contributions of all types, including:DocumentationRight now, tsauditor is in its fairly early stages and lacks extensive documentation apart from the docstrings at the beginning of each .py file. To contribute to documentation, enhance the docstrings by adding concise details for each code snippet.
Example notebooksAn example notebook highlighting different use cases for tsauditor. [EXAMPLE] Adding Example notebooks for a use case) has some good starting points for proposing an example notebook.
Test CasesAdding test cases for general and various edge cases. [TEST] Add edge-case tests for single-row DataFrames and [TEST] Add edge-case tests for all-NaN columns are for edge cases. While, [TEST] Adding more types of tests for use cases is for adding general test cases.
EnhancementsTo add an enhancement, open an issue with the enhancement label, if you wish to contribute, submit a pull request and you are good to go! Make sure your enhancement passes the already present tests. [ENH] Propose default thresholds for a domain="crypto" preset is an enhancement issue. Though it requires domain knowledge.
Bug ReportingGot something the library should do, but doesn't? Or do you have a specific data misfiring in mind? Open an issue with the label bug, follow the guidelines in Bug Reporting
Feature RequestLibrary should do something an existing python or R package does but doesn't? Got another idea? feel free to discuss in the discussions tab or shoot a shot with Request a feature
Things to keep in mind:
Don't forget to run a ruff check
Make sure your code is PEP8 compliant.
Make sure your code passes all the relevant checks
Please comment before you start working on an issue
Got a suggestion? Use the Discussions tab, I will be happy to collaborate