OSS Toolkit Contributing Guide

October 1, 2024 ยท View on GitHub

Thank you for your interest in contributing to Cohere's OSS toolkit. This guide covers the contribution workflow, from opening an issue to reviewing and merging changes. For development setup, please refer to the README.

Getting Started

There are many ways to contribute beyond writing code. You can help by:

Table of Contents

Assumptions

Before contributing, please ensure:

  1. You're familiar with GitHub and the Pull Request (PR) workflow.
  2. You've read Cohere's documentation.
  3. You know about the Cohere community on Discord.

How to Contribute

  1. Open or Find an Issue
    Ensure your contribution addresses an open issue. This helps gauge if the change will be accepted.

  2. Fork the Repository
    Fork this repository to your GitHub account.

  3. Make Your Changes
    Work on your fork and ensure your commits are signed.

  4. Submit a Pull Request (PR)
    Submit your fork as a PR pointing to the main branch. A maintainer will review your PR, but response times may vary.

How to Add Features

Add new features to the community folder. This is where tools and deployments not managed by Codeowners are located.