Friendica Communications Platform (please note that this is a clone of the repository at github, issues are handled there)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

128 lines
4.5 KiB

  1. ## Reporting Bugs
  2. Each bug report MUST have a [JSFiddle/JSBin] recreation before any work can begin. [further instructions »](
  3. ## Requesting Features
  4. 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 »](
  5. ## Contributing Features
  6. 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.
  7. 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.
  8. ## Contributing Bugfixes
  9. 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.
  10. ## Contributing Locales
  11. 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].
  12. ## Other Ways to Contribute
  13. [Read about other ways to contribute »](
  14. ## Getting Set Up
  15. You will need [Git][git], [Node][node], and NPM installed. For clarification, please view the [jQuery readme][jq-readme], which requires a similar setup.
  16. Also, you will need the [gulp-cli][gulp-cli] package installed globally (`-g`) on your system:
  17. npm install -g gulp-cli
  18. Then, clone FullCalendar's git repo:
  19. git clone git://
  20. Enter the directory and install FullCalendar's dependencies:
  21. cd fullcalendar
  22. npm install
  23. ## What to edit
  24. When modifying files, please do not edit the generated or minified files in the `dist/` directory. Please edit the original `src/` files.
  25. ## Development Workflow
  26. 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:
  27. gulp dev
  28. Or, you can run a script that automatically rebuilds whenever you save a source file:
  29. gulp watch
  30. When you are finished, run the following command to write the distributable files into the `./dist/` directory:
  31. gulp dist
  32. If you want to clean up the generated files, run:
  33. gulp clean
  34. ## Style Guide
  35. Please follow the [Google JavaScript Style Guide] as closely as possible. With the following exceptions:
  36. ```js
  37. if (true) {
  38. }
  39. else { // please put else, else if, and catch on a separate line
  40. }
  41. // please write one-line array literals with a one-space padding inside
  42. var a = [ 1, 2, 3 ];
  43. // please write one-line object literals with a one-space padding inside
  44. var o = { a: 1, b: 2, c: 3 };
  45. ```
  46. Other exceptions:
  47. - please ignore anything about Google Closure Compiler or the `goog` library
  48. - please do not write JSDoc comments
  49. Notes about whitespace:
  50. - **use *tabs* instead of spaces**
  51. - separate functions with *2* blank lines
  52. - separate logical blocks within functions with *1* blank line
  53. Run the command line tool to automatically check your style:
  54. gulp lint
  55. ## Before Submitting your Code
  56. 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:
  57. 1. Conformed to the style guide (successfully run `gulp lint`)
  58. 2. Written automated tests. View the [Automated Test Readme]
  59. [JSFiddle/JSBin]:
  60. [Issue Tracker]:
  61. [Using Pull Requests]:
  62. [MomentJS locale data]:
  63. [git]:
  64. [node]:
  65. [gulp-cli]:
  66. [jq-readme]:
  67. [Google JavaScript Style Guide]:
  68. [Automated Test Readme]: