33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
# Contributing Guidelines
|
|
|
|
👋 Hello there! We're thrilled that you're considering contributing to our project. Before you start, please take a moment to read our guidelines.
|
|
|
|
## Table of Contents
|
|
|
|
- [How Can I Contribute?](#how-can-i-contribute)
|
|
- [Reporting Bugs](#reporting-bugs)
|
|
- [Suggesting Enhancements](#suggesting-enhancements)
|
|
- [Code Contribution](#code-contribution)
|
|
|
|
## Code of Conduct
|
|
|
|
None. Don't be a turd and we'll be just fine 'round here. 🤠
|
|
|
|
## How Can I Contribute?
|
|
|
|
### Reporting Bugs
|
|
|
|
Found a bug? Please ensure the bug was not already reported by searching our [issues](../../issues). If not, open a new issue and fill out the template provided.
|
|
|
|
### Suggesting Enhancements
|
|
|
|
Have an idea for an enhancement? We'd love to hear it! Open an issue and include [Feature Request].
|
|
|
|
### Code Contribution
|
|
|
|
1. Fork the repository.
|
|
2. Create a new branch for your feature/fix: `git checkout -b feature-branch`
|
|
3. Make your changes and commit: `git commit -m 'Add new feature'`
|
|
4. Push to your fork: `git push origin feature-branch`
|
|
5. Open a pull request with a clear title and description.
|