Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 1.71 KB

contributing.md

File metadata and controls

56 lines (32 loc) · 1.71 KB
Raw

Thank you for considering contributioning to help Manage Generative AI.

Here are some guidelines to follow:

Reporting Bugs

If you find a bug in the code or documentation, please open a GitHub issue describing the bug. Be sure to include:

  • A clear title and description
  • As much relevant information as possible (code sample, error messages, screenshots, etc)
  • The steps to reproduce the bug

This will help us quickly resolve the issue.

Suggesting Enhancements

We also welcome enhancement suggestions! Open a GitHub issue with the following details:

  • A clear title and description of the enhancement
  • The motivation and use cases for the enhancement
  • An overview of how it could be implemented
  • Any examples or mockups if applicable

This will allow us to have a discussion on if and how the enhancement should be implemented.

Pull Requests

If you would like to directly contribute code:

  1. Fork the repository

  2. Create a new branch from main for your feature or bug fix

  3. Make your changes.

    • Note: If code has been created, where possible please write tests to ensure it functions according to desired outcomes. thoroughly.

    Before pushing, please run the following:

    pre-commit run --all-files

  4. Submit a pull request against the main branch, following the templated requirements.

A few notes:

  • Try to keep PRs small and focused on a single change
  • Make sure all tests are passing and new tests are added if needed
  • Follow the existing code style and conventions
  • Documentation updates are highly appreciated!

Thanks for helping make this project better!