Thank you for your interest in contributing to coco! Your involvement is greatly appreciated, whether it’s reporting bugs, suggesting features, enhancing code quality, or improving documentation. Here’s how to get started:
- Opening Issues: Found a bug, have a suggestion, or need a new feature? Open an issue to let us know.
- Submitting Pull Requests (PRs): Ready to code? Fork this repo, make your changes, and submit a pull request. Please keep the following in mind:
- Clearly describe the problem or feature in your PR message.
- Follow the existing code style and conventions.
- Update documentation if your changes affect it.
Here’s a quick guide to help you set up:
- Fork the Repository: Fork this repo to your GitHub account.
- Clone the Repository: Clone the fork to your local machine.
- Create a Branch for Your Work: Use a descriptive branch name
git checkout -b feat/my-new-feature
- Make and Test Your Changes: Make your improvements and ensure they are well-tested.
- Commit Your Changes: Use a conventional commit message
git commit -m 'feat: ✨ my commit message'
or...coco
;) - Push your branch to your fork:
git push origin feat/my-new-feature
- Open a Pull Request: Submit your PR from your branch on GitHub.
By contributing to lucas-labs/coco, you agree to have your contributions licensed under the MIT License.