Contributing to tritonBLAS

README > Contributing

Contributing to tritonBLAS#

Thank you for your interest in contributing to tritonBLAS! This document provides guidelines for contributing to the project.

Development Setup#

  1. Fork the Repository: Start by forking the tritonBLAS repository on GitHub to your own account.

  2. Clone Your Fork : Clone the repository:

    git clone <YOUR_FORK_URL>

Development Workflow#

  1. Create a Feature Branch:

    git checkout -b feature/your-feature-name

  2. Make Your Changes:

    • Follow the existing code style

    • Add tests for new functionality

    • Update documentation as needed

  3. Test Your Changes:

    # Run code quality checks
ruff check .
ruff format .

# Run tests (if available)
cd <tritonblas_root>/tests
pytest

  4. Commit and Push:

    git add .
git commit -m "Description of your changes"
git push origin feature/your-feature-name

  5. Create a Pull Request:

    • Go to the GitHub repository

    • Create a new pull request from your branch

    • Fill in the PR description with details about your changes

    • Feel free to open a draft PR and ask for early feedback while you’re still working on your changes

License#

By contributing to tritonBLAS, you agree that your contributions will be licensed under the MIT License.

Contents