Sha256: 5915c23e37c7c16e223dbfebe37c2c30fdba33dafd8e91abaaacde521dad2405

Contents?: true

Size: 1.24 KB

Versions: 18

Compression:

Stored size: 1.24 KB

Contents

In order to keep the Curly code base nice and tidy, please observe these best practises when making contributions:

- Add tests for all your code. Make sure the tests are clear and fail with proper error messages. It's a good idea to let your test fail in order to review whether the message makes sense; then make the test pass.
- Document any unclear things in the code. Even better, don't make the code do unclear things.
- Use the coding style already present in the code base.
- Make your commit messages precise and to the point. Add a short summary (50 chars max) followed by a blank line and then a longer description, if necessary, e.g.

  > Make invalid references raise an exception
  >
  > In order to avoid nasty errors when doing stuff, make the Curly compiler
  > fail early when an invalid reference is encountered.


Before making a contribution, you should make sure to understand what Curly is and isn't:

- The template language will never be super advanced: one of the primary use cases for Curly is to allow end users to mess around with Curly templates and have them safely compiled and rendered on a server. As such, the template language will always be as simple as possible.
- The template language is declarative, and is going to stay that way.

Version data entries

18 entries across 18 versions & 1 rubygems

Version Path
curly-templates-3.4.0 CONTRIBUTING.md
curly-templates-3.3.0 CONTRIBUTING.md
curly-templates-3.2.0 CONTRIBUTING.md
curly-templates-3.1.0 CONTRIBUTING.md
curly-templates-3.0.0 CONTRIBUTING.md
curly-templates-2.6.5 CONTRIBUTING.md
curly-templates-2.6.4 CONTRIBUTING.md
curly-templates-2.6.3 CONTRIBUTING.md
curly-templates-2.6.2 CONTRIBUTING.md
curly-templates-2.6.1 CONTRIBUTING.md
curly-templates-2.6.0 CONTRIBUTING.md
curly-templates-2.5.0 CONTRIBUTING.md
curly-templates-2.4.1 CONTRIBUTING.md
curly-templates-2.4.0 CONTRIBUTING.md
curly-templates-2.3.2 CONTRIBUTING.md
curly-templates-2.3.1 CONTRIBUTING.md
curly-templates-2.3.0 CONTRIBUTING.md
curly-templates-2.2.0 CONTRIBUTING.md