First off, thanks for taking the time to contribute! 🎉 The following is a set of guidelines for contributing to Caliban.
This project and everyone participating in it is governed by the Caliban Code of Conduct. By participating, you are expected to uphold this code.
If you find a bug, please report it by opening a new issue in the Issues section and include:
- A clear and descriptive title.
- A detailed description of the problem.
- Steps to reproduce the issue.
- Any relevant logs, screenshots, or files that may help us understand the issue.
If you have an idea for a new feature, please suggest it by opening a new issue in the Issues section and include:
- A clear and descriptive title.
- A detailed description of the feature.
- Any relevant sample code, diagrams, or screenshots.
- Fork the repository.
- Create a new branch (
git checkout -b feature/YourFeature). - Make your changes.
- Format your code using the
fmtcommand in sbt. - Ensure all tests pass.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/YourFeature). - Open a pull request. It will trigger the CI to run various with different Scala versions and platforms.
- If you have questions or need help, feel free to ask on our Discord channel or open an issue.
- Before starting to work on a major change, please open an issue to discuss your proposed changes to ensure they fit within the project's scope and are not already being worked on.
Thank you for contributing to Caliban!