4 Each bug report MUST have a [JSFiddle/JSBin] recreation before any work can begin. [further instructions »](http://fullcalendar.io/wiki/Reporting-Bugs/)
9 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 »](http://fullcalendar.io/wiki/Requesting-Features/)
12 ## Contributing Features
14 The FullCalendar project welcomes [Pull Requests][Using 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.
16 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.
19 ## Contributing Bugfixes
21 In the description of your [Pull Request][Using Pull Requests], 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.
24 ## Contributing Locales
26 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].
29 ## Other Ways to Contribute
31 [Read about other ways to contribute »](http://fullcalendar.io/wiki/Contributing/)
36 You will need [Git][git], [Node][node], and NPM installed. For clarification, please view the [jQuery readme][jq-readme], which requires a similar setup.
38 Also, you will need the [gulp-cli][gulp-cli] package installed globally (`-g`) on your system:
40 npm install -g gulp-cli
42 Then, clone FullCalendar's git repo:
44 git clone git://github.com/fullcalendar/fullcalendar.git
46 Enter the directory and install FullCalendar's dependencies:
54 When modifying files, please do not edit the generated or minified files in the `dist/` directory. Please edit the original `src/` files.
57 ## Development Workflow
59 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:
63 Or, you can run a script that automatically rebuilds whenever you save a source file:
67 When you are finished, run the following command to write the distributable files into the `./dist/` directory:
71 If you want to clean up the generated files, run:
78 Please follow the [Google JavaScript Style Guide] as closely as possible. With the following exceptions:
83 else { // please put else, else if, and catch on a separate line
86 // please write one-line array literals with a one-space padding inside
89 // please write one-line object literals with a one-space padding inside
90 var o = { a: 1, b: 2, c: 3 };
95 - please ignore anything about Google Closure Compiler or the `goog` library
96 - please do not write JSDoc comments
98 Notes about whitespace:
100 - **use *tabs* instead of spaces**
101 - separate functions with *2* blank lines
102 - separate logical blocks within functions with *1* blank line
104 Run the command line tool to automatically check your style:
109 ## Before Submitting your Code
111 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:
113 1. Conformed to the style guide (successfully run `gulp lint`)
115 2. Written automated tests. View the [Automated Test Readme]
118 [JSFiddle/JSBin]: http://fullcalendar.io/wiki/Reporting-Bugs/
119 [Issue Tracker]: https://github.com/fullcalendar/fullcalendar/issues
120 [Using Pull Requests]: https://help.github.com/articles/using-pull-requests/
121 [MomentJS locale data]: https://github.com/moment/moment/tree/develop/locale
122 [git]: http://git-scm.com/
123 [node]: http://nodejs.org/
124 [gulp-cli]: https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md
125 [jq-readme]: https://github.com/jquery/jquery/blob/master/README.md#what-you-need-to-build-your-own-jquery
126 [Google JavaScript Style Guide]: http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
127 [Automated Test Readme]: https://github.com/fullcalendar/fullcalendar/wiki/Automated-Tests