Contributing

We welcome contributions from the community! Whether you’re fixing a bug, adding a feature, or improving documentation, your help is greatly appreciated. Below are guidelines to help you get started.

How to Contribute

    1. Set Up Your Environment

Before you start, make sure you have the following:

  • Python 3.10 or higher: The client is compatible with Python 3.10 and above.

  • Git: For version control.

  • Poetry: For dependency management. Install it by following the [official guide](https://python-poetry.org/docs/#installation).

Clone the repository and set up the project:

git clone https://github.com/vispar-tech/bingx-py.git
cd bingx-py
poetry install

    1. Create a Branch

Always create a new branch for your changes. Use a descriptive name that reflects the purpose of your contribution.

git checkout -b feature/add-new-endpoint

    1. Follow Code Style

  • Use type hints for all functions and methods.

  • Follow PEP 8 for code formatting.

  • Write docstrings for all public methods and classes.

    1. Update Documentation

If your changes affect the API or add new features, update the relevant documentation. Use reStructuredText (.rst) for documentation files.

    1. Submit a Pull Request

Once your changes are ready, push your branch and submit a pull request (PR) to the main branch. Include a clear description of your changes and reference any related issues.

git push origin feature/add-new-endpoint

    1. Code Review

Your PR will be reviewed. Be prepared to address feedback and make additional changes if necessary.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue on GitHub. Follow these guidelines:

Bug Reports

  • Provide a clear description of the issue.

  • Include steps to reproduce the problem.

  • Add expected vs. actual behavior.

  • If possible, include code snippets or error logs.

Feature Requests

  • Describe the feature you would like to see.

  • Explain the use case and why it would be valuable.

  • Provide examples or pseudocode if applicable.

Special Thanks

We appreciate all contributions, big or small. Special thanks to everyone who has helped improve this project!

—

Happy coding! 🚀