-
-
Notifications
You must be signed in to change notification settings - Fork 246
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
e7c802b
commit 1c17243
Showing
1 changed file
with
45 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,45 @@ | ||
# Contributing to Caliban | ||
|
||
First off, thanks for taking the time to contribute! 🎉 | ||
The following is a set of guidelines for contributing to Caliban. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by the [Caliban Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you find a bug, please report it by opening a new issue in the [Issues section](https://github.com/ghostdogpr/caliban/issues) 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. | ||
|
||
### Suggesting Features | ||
|
||
If you have an idea for a new feature, please suggest it by opening a new issue in the [Issues section](https://github.com/ghostdogpr/caliban/issues) and include: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the feature. | ||
- Any relevant sample code, diagrams, or screenshots. | ||
|
||
### Submitting Changes | ||
|
||
1. Fork the repository. | ||
2. Create a new branch (`git checkout -b feature/YourFeature`). | ||
3. Make your changes. | ||
4. Format your code using the `fmt` command in sbt. | ||
5. Ensure all tests pass. | ||
6. Commit your changes (`git commit -m 'Add some feature'`). | ||
7. Push to the branch (`git push origin feature/YourFeature`). | ||
8. Open a pull request. It will trigger the CI to run various with different Scala versions and platforms. | ||
|
||
## Additional Notes | ||
|
||
- If you have questions or need help, feel free to ask on our [Discord channel](https://discordapp.com/channels/629491597070827530/633200096393166868) 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! |