mirror of
https://github.com/Shopify/liquid.git
synced 2026-09-20 03:10:39 -07:00
Grammatic and other fixes to CONTRIBUTING.md
This commit is contained in:
+9
-10
@@ -4,23 +4,22 @@
|
|||||||
|
|
||||||
* Bugfixes
|
* Bugfixes
|
||||||
* Performance improvements
|
* Performance improvements
|
||||||
* Features which are likely to be useful to the majority of Liquid users
|
* Features that are likely to be useful to the majority of Liquid users
|
||||||
|
|
||||||
## Things we won't merge
|
## Things we won't merge
|
||||||
|
|
||||||
* Code which introduces considerable performance degrations
|
* Code that introduces considerable performance degrations
|
||||||
* Code which touches performance critical parts of Liquid and comes without benchmarks
|
* Code that touches performance-critical parts of Liquid and comes without benchmarks
|
||||||
* Features which are not important for most people (we want to keep the core Liquid code small and tidy)
|
* Features that are not important for most people (we want to keep the core Liquid code small and tidy)
|
||||||
* Features which can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
|
* Features that can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
|
||||||
* Code which comes without tests
|
* Code that does not include tests
|
||||||
* Code which breaks existing tests
|
* Code that breaks existing tests
|
||||||
|
|
||||||
## Workflow
|
## Workflow
|
||||||
|
|
||||||
* Fork the Liquid repository
|
* Fork the Liquid repository
|
||||||
* Create a new branch in your fork
|
* Create a new branch in your fork
|
||||||
* If it makes sense, add tests for your code and run a performance benchmark
|
* If it makes sense, add tests for your code and/or run a performance benchmark
|
||||||
* Make sure all tests pass
|
* Make sure all tests pass (`bundle exec rake`)
|
||||||
* Create a pull request
|
* Create a pull request
|
||||||
* In the description, ping one of [@boourns](https://github.com/boourns), [@fw42](https://github.com/fw42), [@camilo](https://github.com/camilo), [@dylanahsmith](https://github.com/dylanahsmith), or [@arthurnn](https://github.com/arthurnn) and ask for a code review.
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user