mirror of
https://github.com/kemko/liquid.git
synced 2026-01-01 15:55:40 +03:00
If a pull request is created by someone who didn't sign the CLA yet, the tests will fail. It requires the contributor to submit a new PR or add an insignificant commit (like an empty commit) to force the tests to rerun on the same PR. If we gently nudge a new contributor to sign the CLA in advance, we can help them avoid the hassle.
27 lines
888 B
Markdown
27 lines
888 B
Markdown
# How to contribute
|
|
|
|
## Things we will merge
|
|
|
|
* Bugfixes
|
|
* Performance improvements
|
|
* Features that are 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
|
|
|
|
## Workflow
|
|
|
|
* [Sign the CLA](https://cla.shopify.com/)
|
|
* Fork the Liquid repository
|
|
* Create a new branch in your fork
|
|
* 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
|
|
|