Skip to content

Commit 8151202

Browse files
committed
Add 'Releasing' workflow to 'CONTRIBUTING.md'
1 parent 6909570 commit 8151202

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,33 @@
22

33
## Things we will merge
44

5-
* Bugfixes
6-
* Performance improvements
7-
* Features that are likely to be useful to the majority of Liquid users
8-
* Documentation updates that are concise and likely to be useful to the majority of Liquid users
5+
- Bugfixes
6+
- Performance improvements
7+
- Features that are likely to be useful to the majority of Liquid users
8+
- Documentation updates that are concise and likely to be useful to the majority of Liquid users
99

1010
## Things we won't merge
1111

12-
* Code that introduces considerable performance degrations
13-
* Code that touches performance-critical parts of Liquid and comes without benchmarks
14-
* Features that are not important for most people (we want to keep the core Liquid code small and tidy)
15-
* Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
16-
* Code that does not include tests
17-
* Code that breaks existing tests
18-
* Documentation changes that are verbose, incorrect or not important to most people (we want to keep it simple and easy to understand)
12+
- Code that introduces considerable performance degrations
13+
- Code that touches performance-critical parts of Liquid and comes without benchmarks
14+
- Features that are not important for most people (we want to keep the core Liquid code small and tidy)
15+
- Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
16+
- Code that does not include tests
17+
- Code that breaks existing tests
18+
- Documentation changes that are verbose, incorrect or not important to most people (we want to keep it simple and easy to understand)
1919

2020
## Workflow
2121

22-
* [Sign the CLA](https://cla.shopify.com/) if you haven't already
23-
* Fork the Liquid repository
24-
* Create a new branch in your fork
25-
* For updating [Liquid documentation](https://shopify.github.io/liquid/), create it from `gh-pages` branch. (You can skip tests.)
26-
* If it makes sense, add tests for your code and/or run a performance benchmark
27-
* Make sure all tests pass (`bundle exec rake`)
28-
* Create a pull request
22+
- [Sign the CLA](https://cla.shopify.com/) if you haven't already
23+
- Fork the Liquid repository
24+
- Create a new branch in your fork
25+
- For updating [Liquid documentation](https://shopify.github.io/liquid/), create it from `gh-pages` branch. (You can skip tests.)
26+
- If it makes sense, add tests for your code and/or run a performance benchmark
27+
- Make sure all tests pass (`bundle exec rake`)
28+
- Create a pull request
29+
30+
## Releasing
31+
32+
- Bump the version in `lib/liquid/version.rb` and merge it on `main`
33+
- Run `rake release` to create the new version tag and deploy the new version to RubyGems
34+
- Create a new release using the [GitHub UI](https://github.com/Shopify/liquid/releases/new)

0 commit comments

Comments
 (0)