Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (18 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.03 KB
Raw

Contributing to GenAI Projects

First off, thanks for taking the time to contribute! 🎉

The goal of this repository is to provide accessible, ready-to-deploy templates for developers learning Generative AI on AWS. We welcome contributions that simplify code, improve documentation, or add new architectural patterns.

How to Contribute

1. Reporting Bugs

If you find a bug (e.g., a Lambda function timeout or a deprecated boto3 method), please create an issue using the label bug.

2. Suggesting Enhancements

Have an idea for a new model integration (e.g., Mistral Large or Anthropic Claude 3.5)? Open an issue with the label enhancement.

3. Pull Requests

  1. Fork the repo.
  2. Create a branch: git checkout -b my-new-feature.
  3. Make sure to update the requirements.txt if you add dependencies.
  4. Submit a PR!

Style Guide

  • Python: Please follow PEP 8 standards.
  • Architecture: If adding a new project, please include a Mermaid.js diagram or a screenshot in the README.

Thanks for building with us!