Marbles Contributing

Want to help improve the demo? Awesome. You can propose and find things to work on in the issues section.

Before writing code, keep these rules in mind:

Code Guidelines

1. Indent with tabs
2. Use single quotes on strings in JS files
   1. Can use double quotes in html/pug files
3. Variable names should use underscores or camelCase, no dashes.
4. Don't bring in a million npm modules into the project if you can help it
5. [Optional] This project has a jshint linter file. If you install a plugin in your IDE it will help enforce other rules. You don't have to pass all the rules, use your own judgement.

PR Guidelines

1. Commits should have brief, meaningful messages (1 sentence or so)
2. The PR title and description should not be blank.
   1. If fixing a Marbles Issue, link to it in the description.
3. Keep PRs scoped to one thing at a time. ie don't tackle two issues in one PR.
4. [Optional] Squash commits that fix things like typos, or fixing mistakes you introduced
   • If you don't follow this rule I may squash your PR into 1 commit