Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (18 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 1.27 KB

Contributing to Inference Gateway

Thank you for considering contributing to Inference Gateway! We welcome contributions in many forms, including bug reports, feature requests, code, and documentation.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub with as much detail as possible. Include steps to reproduce the bug, the expected behavior, and any relevant logs or screenshots.

Requesting Features

We welcome feature requests! Please create an issue on GitHub with a clear description of the feature and its benefits. If possible, include examples of how the feature would be used.

Code Contributions

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Write your code and tests.
  4. Run the tests to ensure everything works.
  5. Commit your changes and push your branch to your fork.
  6. Create a pull request on GitHub.

Code Style

Please follow the coding style used in the project. We use gofmt to format our Go code.

Also semantic-release is being used for automated releases, so please ensure your commits are following conventional commits.

You don't need to install most of the tools if you use VSCode, because there is a dev container.