tweaking grunt task naming; adding CONTRIBUTING guidelines
This commit is contained in:
Родитель
cb49fc6738
Коммит
ea83ed622d
|
@ -0,0 +1,42 @@
|
||||||
|
# Contribution Guidelines
|
||||||
|
|
||||||
|
## Reporting issues
|
||||||
|
|
||||||
|
- **Search for existing issues.** Please check to see if someone else has reported the same issue in our [bug tracker](https://bugzilla.mozilla.org/buglist.cgi?product=Webmaker&component=webmaker.org&resolution=---&list_id=8483855).
|
||||||
|
- **Share as much information as possible.** Include operating system and version, browser and version. Also, include steps to reproduce the bug.
|
||||||
|
|
||||||
|
## Code Style
|
||||||
|
|
||||||
|
### JavaScript
|
||||||
|
|
||||||
|
JS files must pass JSHint using the provided [.jshintrc](https://raw.github.com/mozilla/webmaker-profile/master/.jshintrc) settings.
|
||||||
|
|
||||||
|
Additionally, JS files need to be run through [JSBeautify](https://github.com/einars/js-beautify) with the provided [.jsbeautifyrc](https://raw.github.com/mozilla/webmaker-profile/master/.jsbeautifyrc).
|
||||||
|
|
||||||
|
**TL;DR** – Run `grunt` before pushing a commit. It will validate and beautify your JS.
|
||||||
|
|
||||||
|
#### Variable Naming
|
||||||
|
|
||||||
|
- `lowerCamelCase` General variables
|
||||||
|
- `UpperCamelCase` Constructor functions
|
||||||
|
|
||||||
|
### HTML
|
||||||
|
|
||||||
|
- 2 space indentation
|
||||||
|
- Class names use hypenated case (e.g, `my-class-name`)
|
||||||
|
|
||||||
|
### LESS / CSS
|
||||||
|
|
||||||
|
- 2 space indentation
|
||||||
|
- Always a space after a property's colon (e.g, `display: block;` and not `display:block;`)
|
||||||
|
- End all lines with a semi-colon
|
||||||
|
- For multiple, comma-separated selectors, place each selector on it's own line
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Any patch should be tested in as many of our [supported browsers](https://github.com/mozilla/webmaker-profile/wiki/Browser-Support) as possible. Obviously, access to all devices is rare, so just aim for the best coverage possible. At a minimum please test in all available desktop browsers.
|
||||||
|
|
||||||
|
## Pull requests
|
||||||
|
|
||||||
|
- Try not to pollute your pull request with unintended changes – keep them simple and small. If possible, squash your commits.
|
||||||
|
- Try to share which browsers and devices your code has been tested in before submitting a pull request.
|
|
@ -78,10 +78,10 @@ module.exports = function (grunt) {
|
||||||
grunt.loadNpmTasks('grunt-jsbeautifier');
|
grunt.loadNpmTasks('grunt-jsbeautifier');
|
||||||
grunt.loadNpmTasks('grunt-contrib-jshint');
|
grunt.loadNpmTasks('grunt-contrib-jshint');
|
||||||
|
|
||||||
// Verify code
|
// Clean & verify code (Run before commit)
|
||||||
grunt.registerTask('default', ['recess', 'jsbeautifier:verify', 'jshint']);
|
grunt.registerTask('default', ['recess', 'jsbeautifier:modify', 'jshint']);
|
||||||
|
|
||||||
// Clean code (Run before commit)
|
// Verify code (Read only)
|
||||||
grunt.registerTask('clean', ['jsbeautifier:modify', 'jshint']);
|
grunt.registerTask('validate', ['recess', 'jsbeautifier:verify', 'jshint']);
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
"version": "0.0.182",
|
"version": "0.0.182",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "grunt",
|
"test": "grunt validate",
|
||||||
"postinstall": "./node_modules/.bin/bower install"
|
"postinstall": "./node_modules/.bin/bower install"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|
Загрузка…
Ссылка в новой задаче