Conventions - Githubissues

guardian / grunt-init-scribe-plugin

Template for building a Scribe plugin

0 stars 0 forks source link

Conventions #8

Open cutandpastey opened 9 years ago

cutandpastey commented 9 years ago

As per our meeting yesterday we should add some conventions to the readme. For example:

Distribute BOTH src files and compiled files.
Compiled files should be referenced within the main field of both the package.json and bower.json (so that is the default format).
If you wish to use bower install it locally.
If using bower, add bower install as a npm postinstall step.
Always use npm run build as the default build command.

Please feel free to add more @rrees @theefer @robinedman @hmgibson23 @sihil ?

cutandpastey commented 9 years ago

I realise now that some of these can be added to the project template but it would be good to reference why we are doing it this way.