beg-in / fritz Goto Github PK

I created a development branch so we can develop in a more organized fashion. Master should contain only the most stable version.

We should implement some sort of flow for handling when files are not found. We will have to somehow make this work with #6

Here is a Stack Overflow post on implementing this in Express:
http://stackoverflow.com/questions/6528876/how-to-redirect-404-errors-to-a-page-in-expressjs

This is a far in the future type feature, but I'm considering using some of Chrome's JavaScript hot-reloading features to refresh scripts during development without refreshing the whole page. This issue will serve as documentation through the research process.

AMD modules allow for a hot reload:
https://medium.com/@the1mills/hot-reloading-with-react-requirejs-7b2aa6cb06e1#.2obatx204

Light Table can live edit JavaScript:
https://youtu.be/52SVAMM3V78

Hey all,

I would like to continue keeping touch and developing this library further. I propose we all either connect via Slack, or we start a group hangout. I would like to know your guys' opinion on either of these options!

Hangouts: add me on G+
Slack: email me

Also you should all add yourselves as contributors to package.json!

We need npm version hooks that will run the following tasks:

• gulp test - verify build is stable
• gulp changelog - update the CHANGELOG.md file
• gulp docs - update the README.md file (if necessary)
• add and commit changed files
• push the changes and tags to Github

See the documentation for the npm version command

We should add support for Angular HTML5 Mode and a configuration option that disables or enables it.

See this StackOverflow post

I propose we keep the codebase clean by enhancing integration with the following tools:

• JSHint
• JSCS
• conventional changelog
• Editor Config

JSHint

Right now jshint and conventional changelog are integrated with the project, but we have not been enforcing compliance with them.

Before you commit any JavaScript changes use the gulp jshint task, or while running the development server keep an eye out for any warnings produced by JSHint.

JSCS

JSCS will help us keep a consistent code style throughout all our JavaScript files. This will have to be integrated into this project and possibly gulp-begin.

A good place to get some boilerplate rules would be Bower

Additional resources for JSCS:

• http://jscs.info/rules
• https://yannick.cr/posts/enforcing-coding-rules-in-your-team-with-jscs/post

Conventional Changelog

gulp-begin comes with Conventional Changelog, and we should start following Angular Conventional Commit Format

Editor Config

We should produce a .editorconfig file that will help our editors automatically conform to some of our code style preferences. See the Editor Config homepage.

Additional Comments

I propose the following guidelines

• 4 spaces for indentation
• Single quotes for strings within JavaScript files
• 'use strict'; as the first line in all JavaScript files

You can use Google's JavaScript Style Guide for help with general JavaScript design choices.

TODO

• Documentation for a Contributing section with code style guidelines. Perhaps a CONTRIBUTING.md file.
• Addition of a JSCS task and config file
• Addition of a .editorconfig file