Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (38 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 2.78 KB

Contributing to mozilla.ai Blueprints

Thank you for your interest in contributing to this repository! This project is part of the Blueprints initiative, which empowers developers to integrate AI capabilities into their projects using open-source tools and models.

We welcome all kinds of contributions, from improving customization, to extending capabilities, to fixing bugs. Whether you’re an experienced developer or just starting out, your support is highly appreciated.

How to Contribute

Customize for your use-case or Extend It 🔧

  • Fork this repo and customize it for your own use-case or even extend its capabilities.
  • We'd love to see what you've built! Provided your fork is public, we may reach out to you to feature your work on the Blueprints Hub .

Browse Existing Issues 🔍

  • Check the Issues page to see if there are any tasks you'd like to tackle.
  • Look for issues labeled good first issue if you're new to the project—they're a great place to start.

Report Issues 🐛

  • Found a bug? Open a Bug Report by clicking on 'New Issue'
  • Provide as much detail as possible, including the steps to reproduce the issue and Expected vs. actual behavior

Suggest Features 🚀

  • Have an idea for improving the Blueprint? Open a Feature Request by clicking on 'New Issue'
  • Share why the feature is important and any alternative solutions you’ve considered.

Submit Pull Requests 💻

  • Fork the repository and create a new branch for your changes.
  • Install pre-commit to ensure the code is formatted and standardized correctly, by running pip install pre-commit and then pre-commit install.
  • Ensure your branch is up-to-date with the main branch before submitting the PR
  • Please follow the PR template, adding as much detail as possible, including how to test the changes

Guidelines for Contributions

Coding Standards

  • Install pre-commit to automatically format code and run checks.
  • Follow PEP 8 for Python formatting.
  • Use clear variable and function names and add comments to improve readability.

Testing

  • Write unit and integration tests to ensure your changes work as expected.

Documentation

  • Update docs for changes to functionality and maintain consistency with existing docs.

AI-Generated Code

  • We welcome AI-assisted contributions when used thoughtfully
  • Clearly disclose if any part of your submission was generated or assisted by AI tools.
  • Be aware that AI sometimes generates incorrect code, hallucinates APIs, or uses deprecated methods
  • Demonstrate a thorough understanding of the code you submit.
  • Carefully review, test, and debug all code before submitting. Do not blindly copy-paste output from AI tools.