contributing.md

Contributing to the Contracts Codebase

Introduction

Thank you for considering contributing to the Contracts codebase. This document outlines the process for contributing to the project.

Prerequisites

• conda installation on a system
• Requirements installed from requirements.yml by running conda env create -f requirements.yml && conda activate contracting

Setting Up the Development Environment

1. Fork the repository to your GitHub account.
2. Clone your fork locally: git clone https://github.com/Algorithmic-Alignment-Lab/contracts.git
3. Navigate to the project directory: cd contracts

How to Contribute

1. Create a new branch: git checkout -b feature/my-new-feature
2. Make your changes.
3. Commit your changes: git commit -m "Description of your feature"
4. Push to your fork: git push origin feature/my-new-feature
5. Submit a pull request.

Code Style Guidelines

Please adhere to the Google Style Guide.

Review Process

After you submit your pull request, it will be reviewed by one of the maintainers. This process may take up to one week.

Acknowledgments

• Mehul Damani
• Philip Christophersen
• Andy Haupt