Thank you for investing your time in contributing to our project! 🎊
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README.
If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
Please, follow the official Scala style guide.
We also use scalafmt to check and format scala code, so you could use
any of the following commands to help you:
scalafmtCheckAll # Simply checks the code and reports style errors
scalafmtAll # Checks the code and reformats everything that needs formattingIf you want to contribute solving issues or adding some features, the first thing you should do is to fork the repository.
Your fork repository will copy the current doric GitHub Actions, so you may want to keep it synced and use some of them.
Whenever possible, please follow the Conventional commits specification
- Even if you haven't finished your contribution, we encourage you to push your code and create a PR as a draft so everybody knows it is a working in progress
- Don't forget to link PR to issue.
Congratulations!! 🎉🎉 The doric team thanks you ✨.
We use the squash method while merging, so you will only see just one commit for your contribution.