Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (47 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 3.19 KB

Contributing to CAIRA

Welcome to CAIRA (Composable AI Reference Architectures)! We're excited that you're interested in contributing to this open-source project that provides different reference architectures and infrastructure patterns for AI workloads on Azure.

Microsoft CLA

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to grant us the rights to use your contribution. When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com.

How Can I Contribute?

There are many ways to contribute to CAIRA:

  • Report bugs - Log a Bug Report with detailed reproduction steps
  • Suggest enhancements - Open a Feature Request issue to discuss new features
  • Submit code changes - Fix bugs or implement features - please ensure there is an associated issue with the PR!
  • Improve documentation - Help make our docs clearer and more comprehensive
  • Review pull requests - Help review and test changes from other contributors

Quick Start

  1. Read our Code of Conduct
  2. Set up your development environment - Refer to the developer guide
  3. Choose your contribution type - Refer to Types of Contributions
  4. Follow our development workflow - Refer to Development Workflow
  5. Submit a pull request - Refer to Pull Request Guide

Essential Guidelines

Code Quality

  • Use our linting tools: task lint
  • Write clear, maintainable code

Security

  • Never commit secrets or credentials
  • Report vulnerabilities via the resources available in security guidelines.
  • Follow Azure security best practices

Testing

# Run all tests
task test

# Run linting
task lint

Detailed Guides

Topic Guide
Contribution Types Contribution Types Guide
Development Workflow Developer Workflow Process
Pull Request Process Pull Request Guide
Code Review Code Review Guidelines
Linting Tools Linters

Getting Help

  • Documentation: Check our docs directory
  • Issues: Search existing issues or create a new one
  • Developer Guide: Consult the developer guide for setup help

Thank you for contributing to CAIRA!