-
Notifications
You must be signed in to change notification settings - Fork 4
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
Showing
1 changed file
with
53 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,53 @@ | ||
# Contributing to Gorabbit | ||
|
||
Thank you for your interest in contributing to Gorabbit! We welcome contributions from the community to make our project | ||
better. | ||
|
||
## Getting Started | ||
|
||
Before you start contributing, please make sure you have read the [README](./README.md) to understand the project and | ||
its goals. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you come across a bug or unexpected behavior, please help us by submitting a detailed bug report. Use | ||
the [GitHub Issues](https://github.com/KardinalAI/gorabbit/issues) to report bugs, and make sure to include the | ||
following information: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the issue, including steps to reproduce. | ||
- Information about your environment: Go version, operating system, etc. | ||
|
||
### Suggesting Enhancements | ||
|
||
If you have ideas for enhancements or new features, we would love to hear them! Create an issue | ||
on [GitHub](https://github.com/KardinalAI/gorabbit/issues) with a clear description of your proposal, and we can discuss | ||
it together. | ||
|
||
### Pull Requests | ||
|
||
We welcome contributions in the form of pull requests. If you want to contribute code, please follow these guidelines: | ||
|
||
1. Fork the repository and create your branch from `main`. | ||
2. Make sure your code adheres to the [Go coding standards](https://golang.org/doc/effective_go). | ||
3. Make sure your code respects all [linting rules](./.golangci.yml) using [golangci-lint](https://golangci-lint.run/) | ||
version 1.52.2. | ||
4. Write clear commit messages and include documentation if necessary. | ||
5. Make sure your code passes the existing tests. | ||
6. Open a pull request, providing a clear description of your changes. | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project has a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you are | ||
expected to uphold this code. Please report any unacceptable behavior to an administrator. | ||
|
||
## License | ||
|
||
By contributing to Gorabbit, you agree that your contributions will be licensed under the [LICENSE](./LICENSE) file | ||
associated with this project. | ||
|
||
Thank you for your contributions! | ||
|
||
KardinalAI |