Contributing - RoyalGr4pe/stockx-sdk GitHub Wiki

🀝 Contributing to StockX Python SDK

Thank you for considering contributing to the StockX Python SDK! We welcome contributions of all kinds β€” whether it's bug fixes, feature enhancements, documentation improvements, or general feedback.

πŸ› οΈ How to Contribute

1. Fork the Repository

Click the Fork button on the GitHub repo to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/stockx-sdk.git
cd stockx-sdk

3. Create a New Branch

Name your branch according to the feature or fix you're adding.

git checkout -b feature/add-new-endpoint

4. Make Your Changes

Make the necessary edits in the code or documentation. Make sure to follow the code style already used in the project.

5. Add Tests (If Applicable)

If your change affects core functionality, please add appropriate async test functions.

6. Commit Your Changes

git add .
git commit -m "Add support for XYZ feature"

7. Push and Create Pull Request

git push origin feature/add-new-endpoint

Go to your forked repository and open a Pull Request against the main branch of the original repository.

πŸ“‹ Code Style & Standards

  • Use PEP8 style conventions.
  • Keep functions asynchronous unless sync logic is necessary.
  • Use descriptive variable and function names.
  • Include docstrings for all public functions.

πŸ§ͺ Running Tests

Tests will be added soon. In the meantime, please verify functionality with real or mocked API responses. We recommend using pytest-asyncio for async testing.

πŸ“¦ Dependencies

Install development dependencies (if needed):

pip install -r requirements.txt

πŸ™‹ Need Help?

If you're unsure how to contribute, open an issue or ask in an existing discussion. We’re happy to help!

πŸ’¬ Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Thank you for helping improve the StockX SDK! πŸ™Œ