Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

88 lines (67 loc) · 2.49 KB

README » Contributing to Iris

Contributing to Iris

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

Development Setup

Prerequisites

Iris is a Triton-based framework for Remote Memory Access (RMA) operations. We provide containerized development environments:

Using Docker

./docker/build.sh <image-name>
./docker/run.sh <image-name>
pip install -e ".[dev]"

Using Apptainer

./apptainer/build.sh
./apptainer/run.sh
pip install -e ".[dev]"

Development Workflow

1. Create a Feature Branch

git checkout -b $USER/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
pytest

4. Commit and Push

git add .
git commit -m "Description of your changes"
git push origin $USER/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 Iris, you agree that your contributions will be licensed under the MIT License.