Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (78 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

104 lines (78 loc) · 2.68 KB

Contributing to IntelliPerf

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

Development Setup

Prerequisites

We provide both Apptainer and Docker images containing all the dependencies. To get started, run:

Using Apptainer

./apptainer/build.sh
./apptainer/run.sh

Using Docker

./docker/build.sh
./docker/run.sh

Setting Up Development Environment

  1. Clone the Repository:

    git clone git@github.com:AMDResearch/intelliperf.git
cd intelliperf

  2. Install Development Dependencies:

    pip install -e ".[dev]"

  3. Install Pre-commit Hooks:

    pre-commit install

  4. Run Code Quality Checks:

    pre-commit run --all-files

Development Workflow

  1. Create a New Branch:

    git checkout -b feature/your-feature-name

  2. Commit Your Changes:

    git commit -m "Description of your changes"

  3. Push Your Changes:

    git push origin feature/your-feature-name

  4. Create a Pull Request:

    • Go to the GitHub repository
    • Click "New Pull Request"
    • Select your branch
    • Fill in the PR template
    • Submit the PR

Code Style Guidelines

Code style guidelines are enforced via pre-commit hooks using Ruff. To manually check your code style:

pre-commit run --all-files

License

By contributing to IntelliPerf, you agree that your contributions will be licensed under the project's MIT License.