Create CONTRIBUTING.md
I added the following to it: - Bug reporting - Feature requests - Contributing guide - Style guide
This commit is contained in:
Isiah Meadows
impinball
parent
df114a4ee2
commit
9fab2b8371
18 changed files with 1209 additions and 352 deletions
114
Gruntfile.js
114
Gruntfile.js
|
|
@ -21,7 +21,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
"refactoring",
|
||||
"routing",
|
||||
"tools",
|
||||
"web-services"
|
||||
"web-services",
|
||||
]
|
||||
|
||||
var api = [
|
||||
|
|
@ -42,7 +42,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
"mithril.sync",
|
||||
"mithril.trust",
|
||||
"mithril.withAttr",
|
||||
"mithril.xhr"
|
||||
"mithril.xhr",
|
||||
]
|
||||
|
||||
var md2htmlTasks = {}
|
||||
|
|
@ -59,12 +59,12 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
md2htmlTasks[name] = {
|
||||
options: {
|
||||
layout: inputFolder + "/layout/" + layout + ".html",
|
||||
templateData: {topic: title}
|
||||
templateData: {topic: title},
|
||||
},
|
||||
files: [{
|
||||
src: [src],
|
||||
dest: tempFolder + "/" + name + ".html"
|
||||
}]
|
||||
dest: tempFolder + "/" + name + ".html",
|
||||
}],
|
||||
}
|
||||
})
|
||||
}
|
||||
|
|
@ -79,7 +79,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
eslint: {
|
||||
options: {
|
||||
extensions: [".js"],
|
||||
fix: true
|
||||
fix: true,
|
||||
},
|
||||
all: [
|
||||
"**/*.js",
|
||||
|
|
@ -88,17 +88,17 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
"!archive/**",
|
||||
"!deploy/**",
|
||||
"!mithril.closure-compiler-externs.js",
|
||||
"!docs/layout/lib/**"
|
||||
]
|
||||
"!docs/layout/lib/**",
|
||||
],
|
||||
},
|
||||
|
||||
mocha_phantomjs: { // eslint-disable-line camelcase
|
||||
test: {
|
||||
src: ["test/index.html"],
|
||||
options: {
|
||||
reporter: "dot"
|
||||
}
|
||||
}
|
||||
reporter: "dot",
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
md2html: md2htmlTasks,
|
||||
|
|
@ -111,11 +111,11 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
"http://github.com/lhorie/mithril.js",
|
||||
"(c) Leo Horie",
|
||||
"License: MIT",
|
||||
"*/"
|
||||
"*/",
|
||||
].join("\n"),
|
||||
sourceMap: true
|
||||
sourceMap: true,
|
||||
},
|
||||
mithril: {src: "mithril.js", dest: "mithril.min.js"}
|
||||
mithril: {src: "mithril.js", dest: "mithril.min.js"},
|
||||
},
|
||||
|
||||
zip: {
|
||||
|
|
@ -124,10 +124,10 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
src: [
|
||||
currentVersionArchiveFolder + "/mithril.min.js",
|
||||
currentVersionArchiveFolder + "/mithril.min.js.map",
|
||||
currentVersionArchiveFolder + "/mithril.js"
|
||||
currentVersionArchiveFolder + "/mithril.js",
|
||||
],
|
||||
dest: currentVersionArchiveFolder + "/mithril.min.zip"
|
||||
}
|
||||
dest: currentVersionArchiveFolder + "/mithril.min.zip",
|
||||
},
|
||||
},
|
||||
|
||||
replace: {
|
||||
|
|
@ -135,105 +135,105 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
force: true,
|
||||
patterns: [
|
||||
{match: /\.md/g, replacement: ".html"},
|
||||
{match: /\$version/g, replacement: version}
|
||||
]
|
||||
{match: /\$version/g, replacement: version},
|
||||
],
|
||||
},
|
||||
|
||||
links: {
|
||||
expand: true,
|
||||
flatten: true,
|
||||
src: [tempFolder + "/**/*.html"],
|
||||
dest: currentVersionArchiveFolder + "/"
|
||||
dest: currentVersionArchiveFolder + "/",
|
||||
},
|
||||
|
||||
index: {
|
||||
src: inputFolder + "/layout/index.html",
|
||||
dest: currentVersionArchiveFolder + "/index.html"
|
||||
dest: currentVersionArchiveFolder + "/index.html",
|
||||
},
|
||||
|
||||
commonjs: {
|
||||
expand: true,
|
||||
flatten: true,
|
||||
src: [inputFolder + "/layout/*.json"],
|
||||
dest: currentVersionArchiveFolder
|
||||
dest: currentVersionArchiveFolder,
|
||||
},
|
||||
|
||||
cdnjs: {
|
||||
src: "deploy/cdnjs-package.json",
|
||||
dest: "../cdnjs/ajax/libs/mithril/package.json"
|
||||
}
|
||||
dest: "../cdnjs/ajax/libs/mithril/package.json",
|
||||
},
|
||||
},
|
||||
|
||||
copy: {
|
||||
style: {
|
||||
src: inputFolder + "/layout/style.css",
|
||||
dest: currentVersionArchiveFolder + "/style.css"
|
||||
dest: currentVersionArchiveFolder + "/style.css",
|
||||
},
|
||||
|
||||
pages: {
|
||||
src: inputFolder + "/layout/pages.json",
|
||||
dest: currentVersionArchiveFolder + "/pages.json"
|
||||
dest: currentVersionArchiveFolder + "/pages.json",
|
||||
},
|
||||
|
||||
lib: {
|
||||
expand: true,
|
||||
cwd: inputFolder + "/layout/lib/",
|
||||
src: "./**",
|
||||
dest: currentVersionArchiveFolder + "/lib/"
|
||||
dest: currentVersionArchiveFolder + "/lib/",
|
||||
},
|
||||
|
||||
tools: {
|
||||
expand: true,
|
||||
cwd: inputFolder + "/layout/tools/",
|
||||
src: "./**",
|
||||
dest: currentVersionArchiveFolder + "/tools/"
|
||||
dest: currentVersionArchiveFolder + "/tools/",
|
||||
},
|
||||
|
||||
comparisons: {
|
||||
expand: true,
|
||||
cwd: inputFolder + "/layout/comparisons/",
|
||||
src: "./**",
|
||||
dest: currentVersionArchiveFolder + "/comparisons/"
|
||||
dest: currentVersionArchiveFolder + "/comparisons/",
|
||||
},
|
||||
|
||||
unminified: {
|
||||
src: "mithril.js",
|
||||
dest: currentVersionArchiveFolder + "/mithril.js"
|
||||
dest: currentVersionArchiveFolder + "/mithril.js",
|
||||
},
|
||||
|
||||
minified: {
|
||||
src: "mithril.min.js",
|
||||
dest: currentVersionArchiveFolder + "/mithril.min.js"
|
||||
dest: currentVersionArchiveFolder + "/mithril.min.js",
|
||||
},
|
||||
|
||||
readme: {
|
||||
src: "README.md",
|
||||
dest: currentVersionArchiveFolder + "/README.md"
|
||||
dest: currentVersionArchiveFolder + "/README.md",
|
||||
},
|
||||
|
||||
map: {
|
||||
src: "mithril.min.js.map",
|
||||
dest: currentVersionArchiveFolder + "/mithril.min.js.map"
|
||||
dest: currentVersionArchiveFolder + "/mithril.min.js.map",
|
||||
},
|
||||
|
||||
typescript: {
|
||||
src: "mithril.d.ts",
|
||||
dest: currentVersionArchiveFolder + "/mithril.d.ts"
|
||||
dest: currentVersionArchiveFolder + "/mithril.d.ts",
|
||||
},
|
||||
|
||||
publish: {
|
||||
expand: true,
|
||||
cwd: currentVersionArchiveFolder,
|
||||
src: "./**",
|
||||
dest: outputFolder
|
||||
dest: outputFolder,
|
||||
},
|
||||
|
||||
archive: {
|
||||
expand: true,
|
||||
cwd: currentVersionArchiveFolder,
|
||||
src: "./**",
|
||||
dest: outputFolder + "/archive/v" + version
|
||||
}
|
||||
dest: outputFolder + "/archive/v" + version,
|
||||
},
|
||||
},
|
||||
|
||||
"saucelabs-browsers": {
|
||||
|
|
@ -245,7 +245,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
return version === "dev" || version === "beta" ||
|
||||
+version >= 38 // The latest ESR version
|
||||
})
|
||||
}
|
||||
},
|
||||
},
|
||||
|
||||
chrome: {
|
||||
|
|
@ -256,7 +256,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
return version === "dev" || version === "beta" ||
|
||||
+version >= 41
|
||||
})
|
||||
}
|
||||
},
|
||||
},
|
||||
|
||||
ie: {
|
||||
|
|
@ -265,7 +265,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
return browser.browserName === "internet explorer" &&
|
||||
!/2003/.test(browser.platform)
|
||||
})
|
||||
}
|
||||
},
|
||||
},
|
||||
|
||||
edge: {
|
||||
|
|
@ -273,7 +273,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
return browsers.filter(function (browser) {
|
||||
return browser.browserName === "microsoftedge"
|
||||
})
|
||||
}
|
||||
},
|
||||
},
|
||||
|
||||
safari: {
|
||||
|
|
@ -281,7 +281,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
return browsers.filter(function (browser) {
|
||||
return browser.browserName === "safari"
|
||||
})
|
||||
}
|
||||
},
|
||||
},
|
||||
|
||||
opera: {
|
||||
|
|
@ -289,8 +289,8 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
return browsers.filter(function (browser) {
|
||||
return browser.browserName === "opera"
|
||||
})
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
saucelabs: {
|
||||
|
|
@ -303,7 +303,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
urls: ["http://localhost:8000/test/index.html"],
|
||||
sauceConfig: {
|
||||
"record-video": false,
|
||||
"record-screenshots": false
|
||||
"record-screenshots": false,
|
||||
},
|
||||
build: process.env.TRAVIS_JOB_ID,
|
||||
onTestComplete: function (result, callback) {
|
||||
|
|
@ -312,13 +312,13 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
|
||||
var url = [
|
||||
"https://saucelabs.com/rest/v1", user, "jobs",
|
||||
result.job_id
|
||||
result.job_id,
|
||||
].join("/")
|
||||
|
||||
require("request").put({
|
||||
url: url,
|
||||
auth: {user: user, pass: pass},
|
||||
json: {passed: result.passed}
|
||||
json: {passed: result.passed},
|
||||
}, function (error, response) {
|
||||
if (error) {
|
||||
return callback(error)
|
||||
|
|
@ -331,24 +331,24 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
}
|
||||
})
|
||||
},
|
||||
tunnelTimeout: 5
|
||||
}
|
||||
}
|
||||
tunnelTimeout: 5,
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
connect: {
|
||||
server: {
|
||||
options: {
|
||||
port: 8888,
|
||||
base: "."
|
||||
}
|
||||
}
|
||||
base: ".",
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
clean: {
|
||||
options: {force: true},
|
||||
generated: [tempFolder]
|
||||
}
|
||||
generated: [tempFolder],
|
||||
},
|
||||
})
|
||||
|
||||
grunt.loadNpmTasks("grunt-saucelabs-browsers")
|
||||
|
|
@ -370,7 +370,7 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
"md2html",
|
||||
"replace",
|
||||
"copy",
|
||||
"clean"
|
||||
"clean",
|
||||
])
|
||||
|
||||
grunt.registerTask("test", ["eslint:all", "mocha_phantomjs"])
|
||||
|
|
@ -379,6 +379,6 @@ module.exports = function (grunt) { // eslint-disable-line
|
|||
grunt.registerTask("sauce", [
|
||||
"saucelabs-browsers:all",
|
||||
"connect",
|
||||
"saucelabs"
|
||||
"saucelabs",
|
||||
])
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue