UNPKG

1.58 kBMarkdownView Raw
1Contributing to YUIDoc
2======================
3
4Getting Involved
5----------------
6
7If you want to work on the default theme or need to work on the libraries, here's the steps:
8
9 $ git clone git://github.com/fireball-x/firedoc.git
10 $ cd firedoc
11 $ npm link
12
13This will link `yuidoc` into the global folder. This basically installs it globally as a
14link to this source directory.
15
16Now all changes you make to the current source tree are available in the global `yuidoc`
17executable. No need to reinstall the app to test your changes.
18
19Running Unit Tests
20------------------
21
22You are also able to run unit tests by executing `npm test`.
23
24 $ npm test
25
26Server Mode
27-----------
28
29For performance, the Handlebars templates are cached from the first request. So you will have
30to terminate the server and relaunch it before you can see your changes.
31
32Assets should not be cached, so they should still serve new files on each request. This way
33you can modify the JavaScript and CSS files on the fly.
34
35Submitting Pull Requests
36------------------------
37
38Pull Requests are very welcome, but should be within the scope of the project, and follow the
39repository's code conventions. Before submitting a Pull Request, it's always good to file an
40issue, so we can discuss the details of the Pull Request.
41
42The Yahoo CLA
43-------------
44
45At Yahoo, we have a single [Yahoo Open Source Contributor License Agreement][CLA] that we ask
46contributors to electronically sign before merging in their Pull Requests.
47
48[CLA]: https://yahoocla.herokuapp.com/