|
|
11 年之前 | |
|---|---|---|
| dev | 11 年之前 | |
| .editorconfig | 11 年之前 | |
| .gitattributes | 11 年之前 | |
| .gitignore | 11 年之前 | |
| CHANGES.md | 11 年之前 | |
| CONTRIBUTING.md | 11 年之前 | |
| LICENSE.md | 11 年之前 | |
| README.md | 11 年之前 | |
| gruntfile.js | 11 年之前 | |
| package.json | 11 年之前 |
A boilerplate file structure to be used by git based projects. It contains most of the files expected to be inside CKEditor related repositories.
This is for generic purposes, so it can be used by any project out there.
All projects must have a README.md file, which replaces this one.
Includes the default license terms used by most of CKEditor projects.
Describes the standard contribution process adopted by CKEditor projects.
A template for the changelog file.
This is the grunt configuration file. It exposes the following tasks:
grunt default: Alias for jshint:git and jscs:git tasks.grunt githooks: Installs a git pre-commit hook to run grunt default.grunt jscs: JavaScript code style checker with JSCS.grunt jshint: Validate JavaScript files with JSHint.The jscs:git and jshint:git variations run the checks on files that will endup into the next git commit only. It's
therefore much faster.
All grunt tasks are available inside the dev/tasks directory.
The npm configuration file, which describes the project and includes dependencies for node tools used in the project.
###.gitattributes
EOL and content type rules for git.
The list of paths to be ignored by git. It also sets the list of paths to be ignored by the jscs:git and jshint:git
grunt tasks.
Unified configurations for IDEs. See editorconfig.org for more information.
This repository can be used as a starting point for new projects or to bring existing projects to a common pattern. It helps bringing a uniform form among different projects.
The following steps assume that you're located inside your local clone of the target repository.
git remote add boilerplate https://github.com/ckeditor/ckeditor-boilerplate.git
git fetch boilerplate
git merge boilerplate/master
If files are present in your repo, there may be the chance that the merge will cause conflicts. Generally it is straightforward to have them resolved.
Just repeat "2".
The boilerplate contains generic files, many of them serving as templates for your projects. The following are the things to do once you incorporate it into your project.
Reviewing files content:
Assuming that npm and grunt are installed globally, run a few commands:
npm install: download all project dependencies into node_modules.grunt githooks: (optional) if you want to have pre-commit linting enabled straight into your project.Copyright (c) 2014 CKSource - Frederico Knabben
All boilerplate code is licensed under the terms of the MIT license.
Although LICENSE.md is available in this repository as a template for your project, it doesn't apply for the
boilerplate project itself.