Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.9 KB
Raw

Contributing to groq-go

Thank you for considering contributing to groq-go! Your help is greatly appreciated. Below are some guidelines to help you get started.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

How to Report Bugs

If you find a bug in the project, please open an issue on GitHub with a detailed description of the problem, including steps to reproduce it and any error messages you may have encountered.

How to Request Features

If you have an idea for a new feature, please open an issue on GitHub and provide a detailed description of the feature and why you believe it would be useful.

How to Submit a Pull Request

Before submitting a pull request, please ensure your changes adhere to the following guidelines:

  1. Fork the repository and create your branch from the main branch.
  2. Run tests to ensure your changes do not break existing functionality.
  3. Commit your changes with a clear and concise message.
  4. Push your branch to your forked repository.
  5. Open a pull request on the main repository.

Coding Standards

  • Follow the Go style guide.
  • Ensure your code is well-documented.

Testing Instructions

  1. Make sure you have a Groq key set in the environment variable GROQ_KEY.
  2. Run the tests using the command: 
    task test

Branch Naming Conventions

Use descriptive names for your branches, such as feature/add-xyz or bugfix/fix-abc.

Commit Message Guidelines

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.

Getting Help

If you need help, feel free to reach out by opening an issue or joining the discussion in the repository.