diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 777e91e..d6034c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,23 +4,22 @@ * Bugfixes * 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 -* 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 +* 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 * 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 +* 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 -* 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.