Skip to content

Commit

Permalink
Add 'Releasing' workflow to 'CONTRIBUTING.md'
Browse files Browse the repository at this point in the history
  • Loading branch information
karreiro committed Jan 14, 2025
1 parent 6909570 commit 8151202
Showing 1 changed file with 24 additions and 18 deletions.
42 changes: 24 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,33 @@

## Things we will merge

* Bugfixes
* Performance improvements
* Features that are likely to be useful to the majority of Liquid users
* Documentation updates that are concise and likely to be useful to the majority of Liquid users
- Bugfixes
- Performance improvements
- Features that are likely to be useful to the majority of Liquid users
- Documentation updates that are concise and likely to be useful to the majority of Liquid users

## Things we won't merge

* Code that introduces considerable performance degrations
* Code that touches performance-critical parts of Liquid and comes without benchmarks
* Features that are not important for most people (we want to keep the core Liquid code small and tidy)
* Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
* 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)
- Code that introduces considerable performance degrations
- Code that touches performance-critical parts of Liquid and comes without benchmarks
- Features that are not important for most people (we want to keep the core Liquid code small and tidy)
- Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
- 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)

## Workflow

* [Sign the CLA](https://cla.shopify.com/) if you haven't already
* Fork the Liquid repository
* Create a new branch in your fork
* For updating [Liquid documentation](https://shopify.github.io/liquid/), create it from `gh-pages` branch. (You can skip tests.)
* 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
- [Sign the CLA](https://cla.shopify.com/) if you haven't already
- Fork the Liquid repository
- Create a new branch in your fork
- For updating [Liquid documentation](https://shopify.github.io/liquid/), create it from `gh-pages` branch. (You can skip tests.)
- 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

## Releasing

- Bump the version in `lib/liquid/version.rb` and merge it on `main`
- Run `rake release` to create the new version tag and deploy the new version to RubyGems
- Create a new release using the [GitHub UI](https://github.com/Shopify/liquid/releases/new)

0 comments on commit 8151202

Please sign in to comment.