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