squirrellyjs / squirrelly

Semi-embedded JS template engine that supports helpers, filters, partials, and template inheritance. 4KB minzipped, written in TypeScript β›Ί
https://squirrelly.js.org
MIT License
635 stars 83 forks source link

Add comments explaining test file #25

Closed first-timers[bot] closed 6 years ago

first-timers[bot] commented 6 years ago

πŸ†•πŸ₯☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you πŸ’

About First Timers Only.

πŸ€” What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

πŸ“‹ Step by Step

@@ -2,6 +2,10 @@
 var assert = require('assert')
 var Sqrl = require('../dist/squirrelly.min.js')

+// This is a mocha test file containing a couple of tests to make sure Squirrelly isn't broken.
+// The code at the bottom tests that when you render simpleTemplate with options, it equals simpleTemplateResult.
+// It also tests that bigTemplate, rendered, equals bigTemplateResult.
+
 var simpleTemplate = `
 {{title}}
 `
@@ -93,4 +97,4 @@ describe('Complex Compilation', function () {
   it('Comprehensive template returns correct value', function () {
     assert.strictEqual(Sqrl.Render(bigTemplate, data), bigTemplateResult)
   })
-})
\ No newline at end of file
+})
  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can edit files directly in your browser

πŸ€”β“ Questions

Leave a comment below!

This issue was created by First-Timers-Bot.

ajcsilva commented 6 years ago

Hi, looking for my first commit! Can I take this?

archu5 commented 6 years ago

hey my first contribution accept me

heitorsilva commented 6 years ago

Hi! Can I work on this one?

nebrelbug commented 6 years ago

I'm going to let @archu5 have first dibs on this issue.

@ajisilva and @heitorsilva thanks for your enthusiasm! There are some other issues, like #28 and #29, that you can work on if you'd like. If so, comment quickly and I'll reserve the issue for you.

nebrelbug commented 6 years ago

Thanks @archu5!