👍 🎉 First off, thanks for taking the time to contribute! 👍 🎉
The following is a set of guidelines for contributing to cinzel, which is hosted in the YLD Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the cinzel's Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to cinzel@yld.com.
We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources above.
❗ Before submitting a bug report, please check the discussions for a list of common questions and problems 🙏.
This section guides you through submitting a bug report for cinzel. Following these guidelines will help maintainers and the community understand your report, reproduce the behavior and find related reports.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template as the information will help us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Explain the problem and include additional details to help maintainers reproduce the problem;
- Include details about your configuration and environment;
Choose the Bug report Issue template to report a bug.
This section guides you through submitting an enhancement suggestion for cinzel, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
They follow the same principal as Reporting Bugs, but chosing a different Issue template, in this case Feature.
cinzel changelogs are managed with git-cliff.
Generate changelog with mise:
mise run changelog
Recommended release flow:
- Run
mise run changelog. - Commit the resulting
CHANGELOG.md. - Publish GitHub release tag
v<next-version>.