Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

51 lines (29 loc) · 2.51 KB

Contributing to Profit Taker Analytics

Thank you for your interest in contributing to our app! We greatly appreciate your enthusiasm and willingness to help improve our project. However, please note that due to security concerns, certain parts of the codebase are not visible or shareable.

While we understand this limitation may affect the scope of contributions, there are still various ways you can contribute to the project.

How to Contribute

We value contributions in various forms, including bug reports, feature requests, code enhancements, documentation improvements, and translations. Here's a brief guide on how you can contribute:

Reporting Bugs

If you encounter a bug or unexpected behavior, please open a GitHub issue. Include detailed information about the issue, such as steps to reproduce, expected behavior, and actual behavior.

Requesting Features

Have an idea for a new feature or enhancement? Open a GitHub issue to discuss and describe the proposed feature, its use case, and any relevant information.

Code Contributions

As the app's code is only partially visible, most code contributions will be for the python parser.

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make changes and commit them with clear, concise messages.
  4. Push changes to your fork.
  5. Submit a pull request to the main repository.

Before submitting a pull request:

  • Adhere to the project's coding style and conventions.
  • Include tests for your changes if applicable.
  • Update the documentation as needed.

Documentation Contributions

Improvements to documentation are always welcome. If you find typos, unclear wording, or missing information, submit a pull request to enhance the documentation.

Translation Contributions

We offer many languages on our app, if you'd like to contribute translations to the app please contact Basi through email [email protected] or via Discord: basi__.

Code of Conduct

This project follows a Code of Conduct. Please uphold this code while participating. Report any unacceptable behavior.

License

By contributing to Profit Taker Analytics, you acknowledge and agree that your contributions will be subject to the licensing terms specified in the project's license file. It's important to note that the parser and the app components have distinct licenses, each specified within their respective folders. More information is available in the projects license.

Thank you for contributing to Profit Taker Analytics!