-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
be053f4
commit 57918ce
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# 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](https://www.contributor-covenant.org/version/2/0/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](https://golang.org/doc/effective_go.html). | ||
- 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: | ||
```bash | ||
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. |