📢 Code Freeze Notice: This project is currently under a limited code freeze while we work on an alternative frontend (a DSL). We are still accepting bug fixes, but new features will not be merged until the DSL is released. Thank you for your understanding!
- Bugfixes
- Performance improvements
- Features that are likely to be useful to the majority of Roast users
- Documentation updates that are concise and likely to be useful to the majority of Roast users
- Code that introduces considerable performance degrations
- Code that touches performance-critical parts of Roast and comes without benchmarks
- Features that are not important for most people (we want to keep the core Roast code small and tidy)
- Features that can easily be implemented on top of Roast
- Code that does not include tests
- Code that breaks existing tests
- Documentation changes that are verbose, incorrect or not important to most people (we want to keep it simple and easy to understand)
- Sign the CLA if you haven't already
- Fork the Roast repository
- Create a new branch in your fork
- For updating Roast documentation, create it from
gh-pagesbranch. (You can skip tests.)
- For updating Roast documentation, create it from
- If it makes sense, add tests for your code and/or run a performance benchmark
- Make sure all tests pass (
bundle exec rake) - Create a pull request
- Bump the version in
lib/roast/version.rb - Update the
CHANGELOG.mdfile - Open a PR like and merge it to
main - Create a new release using the GitHub UI