Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

90 lines (62 loc) · 2.08 KB

Contributing to the Inference Gateway Go SDK

Thank you for your interest in contributing to the Inference Gateway Go SDK! This document provides guidelines and steps for contributing.

Table of Contents

Development Setup

  1. Prerequisites:
  • docker
  1. Clone and setup:
git clone https://github.com/inference-gateway/sdk
code sdk
  1. Click on the Reopen in Container button in the bottom right corner of the window.

Development Process

  1. Create a new branch:
git checkout -b my-feature
  1. Make changes and test:
go test ./...

  1. Add tests for new features or fix tests for refactoring and bug fixes.

  2. Run linter:

go fmt ./...

Pull Request Process

  1. Commit changes:
git add .
git commit -m "Add my feature"

Types:

  • feat: new feature
  • fix: bug fix
  • refactor: code change that neither fixes a bug nor adds a feature
  • docs: documentation
  • style: formatting, missing semi colons, etc; no code change
  • test: adding missing tests
  • chore: updating build tasks, package manager configs, etc; no production code change
  • ci: changes to CI configuration files and scripts
  • perf: code change that improves performance
  1. Ensure your PR:
  • Passes all tests
  • Updates documentation as needed
  • Includes tests for new features
  • Has a clear description of changes

Release Process

  1. Merging to main triggers CI checks
  2. Manual release workflow can be triggered from Actions
  3. Version is determined by commit messages
  4. Changelog is automatically generated

Getting Help