CONTRIBUTING.md 4.5 KB
Reporting Bugs
Each bug report MUST have a JSFiddle/JSBin recreation before any work can begin. further instructions »
Requesting Features
Please search the Issue Tracker to see if your feature has already been requested, and if so, subscribe to it. Otherwise, read these further instructions »
Contributing Features
The FullCalendar project welcomes Pull Requests for new features, but because there are so many feature requests (over 100), and because every new feature requires refinement and maintenance, each PR will be prioritized against the project's other demands and might take a while to make it to an official release.
Furthermore, each new feature should be designed as robustly as possible and be useful beyond the immediate usecase it was initially designed for. Feel free to start a ticket discussing the feature's specs before coding.
Contributing Bugfixes
In the description of your Pull Request, please include recreation steps for the bug as well as a JSFiddle/JSBin demo. Communicating the buggy behavior is a requirement before a merge can happen.
Contributing Locales
Please edit the original files in the locale/ directory. DO NOT edit anything in the dist/ directory. The build system will responsible for merging FullCalendar's locale/ data with the MomentJS locale data.
Other Ways to Contribute
Read about other ways to contribute »
Getting Set Up
You will need Git, Node, and NPM installed. For clarification, please view the jQuery readme, which requires a similar setup.
Also, you will need the gulp-cli package installed globally (-g) on your system:
npm install -g gulp-cli
Then, clone FullCalendar's git repo:
git clone git://github.com/fullcalendar/fullcalendar.git
Enter the directory and install FullCalendar's dependencies:
cd fullcalendar
npm install
What to edit
When modifying files, please do not edit the generated or minified files in the dist/ directory. Please edit the original src/ files.
Development Workflow
After you make code changes, you'll want to compile the JS/CSS so that it can be previewed from the tests and demos. You can either manually rebuild each time you make a change:
gulp dev
Or, you can run a script that automatically rebuilds whenever you save a source file:
gulp watch
When you are finished, run the following command to write the distributable files into the ./dist/ directory:
gulp dist
If you want to clean up the generated files, run:
gulp clean
Style Guide
Please follow the Google JavaScript Style Guide as closely as possible. With the following exceptions:
if (true) {
}
else { // please put else, else if, and catch on a separate line
}
// please write one-line array literals with a one-space padding inside
var a = [ 1, 2, 3 ];
// please write one-line object literals with a one-space padding inside
var o = { a: 1, b: 2, c: 3 };
Other exceptions:
- please ignore anything about Google Closure Compiler or the
googlibrary - please do not write JSDoc comments
Notes about whitespace:
- use tabs instead of spaces
- separate functions with 2 blank lines
- separate logical blocks within functions with 1 blank line
Run the command line tool to automatically check your style:
gulp lint
Before Submitting your Code
If you have edited code (including tests and translations) and would like to submit a pull request, please make sure you have done the following:
Conformed to the style guide (successfully run
gulp lint)Written automated tests. View the Automated Test Readme