sharpetronics/liquid
1
0
Fork 0
mirror of https://github.com/Shopify/liquid.git synced 2025-10-04 00:00:17 -04:00
Code Issues Projects Releases Wiki Activity

CONTRIBUTING.md

Browse Source
This commit is contained in:
Florian Weingarten 2013-06-14 02:41:08 +02:00
parent 5cfa13d7a4
commit 27db1def63
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,26 @@
# How to contribute
## Things we will merge
* Bugfixes
* Performance improvements
* Features which are likely to be useful to the majority of Liquid users
## Things we won't merge
* Code which introduces considerable performance degrations
* Code which 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 which can easily be implemented on top of Liquid (for example as a custom filter or custom filesystem)
* Code which comes without tests
* Code which breaks existing tests
## Workflow
* Fork the Liquid repository
* Create a new branch in your fork
* If it makes sense, add tests for your code and run a performance benchmark
* Make sure all tests pass
* 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), or [@dylanahsmith](https://github.com/dylanahsmith) and ask for a code review.