contributing.md

[ericelliott]

We need a contributing.md doc that shares community conventions.

Stamp conventions

• Naming stamps: your-module-name-stamp
• Keywords for package.json: stamp, stampit

Automatic code quality conventions 😎

• Use the prod-module-boilerplate (soon to be replaced with npm install -g cloverfield cf-package && cf build package) - see Cloverfield
• Remember to add unit tests tape or blue-tape preferred. Aim for 100% coverage (see generated coverage directory for reports)
• Use CI integration with CircleCI or Travis

Getting your stamp added to stampit-org:

• Create a new issue with [new stamp] in the title.

cc @troutowicz @nkbt @unstoppablecarl

[ericelliott]

Thoughts?

[nkbt]

Little fix: npm install -g cloverfield cf-package && cf build package. Unless you want Cloverfield to automatically fetch missing packages.

Rest seems good for me

[ericelliott]

👍

I do want it to auto-fetch missing packages, but that's a different ticket. ;)

[ericelliott]

If we close the auto-fetch issue, we can change back to npm install -g cloverfield && cf build package.

❔

[nkbt]

Exactly. Should work like that.

[ericelliott]

👍

[ericelliott]

Updated to move -stamp to the end of the module name instead of the beginning. Reads better. =)

[koresar]

+1