|
1 Contributing to YUI |
|
2 =================== |
|
3 |
|
4 The YUI Project is a two-way open-source project managed by the YUI engineering |
|
5 team at Yahoo!. Please read about our |
|
6 [Contributor Model](https://github.com/yui/yui3/wiki/Contributor-Model) |
|
7 for more details. |
|
8 |
|
9 |
|
10 Getting Started |
|
11 --------------- |
|
12 (see also [Developer Workflow](https://github.com/yui/yui3/wiki/Developer-Workflow) ) |
|
13 |
|
14 **Join YUILibrary.com** |
|
15 |
|
16 Create a free account on |
|
17 [YUILibrary.com](http://yuilibrary.com/forum/ucp.php?mode=register) account so |
|
18 you can: |
|
19 |
|
20 * [Create bugs](https://github.com/yui/yui3/issues/new) and |
|
21 enhancement requests. |
|
22 * Post on the [support forum](http://yuilibrary.com/forum/). |
|
23 * Contribute modules to the [Gallery](http://yuilibrary.com/gallery/). |
|
24 * Contribute documentation, examples or code to the core library. (You will |
|
25 also need a GitHub account and signed CLA - see below). |
|
26 |
|
27 **Join GitHub.com** |
|
28 |
|
29 Create a free account on [GitHub](https://github.com/signup/free) so you can: |
|
30 |
|
31 * Fork the source code. |
|
32 * Contribute modules to the Gallery. (You can now use your own repo as the |
|
33 source.) |
|
34 * Contribute documentation, examples or code to the core library. |
|
35 |
|
36 **Submit a CLA** |
|
37 |
|
38 Sign and submit a [Contributor License Agreement (CLA)](http://yuilibrary.com/contribute/cla/) so you can: |
|
39 |
|
40 * Have your Gallery modules hosted on the Yahoo! CDN. |
|
41 * Contribute bug fixes and enhancements to the core library. |
|
42 * Make sure you check **"individual"** or **"company"** in the CLA form. |
|
43 |
|
44 **Join YUI Contributor Mailing List** |
|
45 |
|
46 Join the [mailing list](https://groups.google.com/forum/?fromgroups=#!forum/yui-contrib) so you can: |
|
47 * Discuss technical issues about your feature. |
|
48 * Contribute to ongoing discussions around YUI features. |
|
49 * Read about major pull requests and give feedback. |
|
50 |
|
51 **Fork Repo** |
|
52 * Visit https://github.com/yui/yui3 and click the fork button. |
|
53 * Clone this fork down to your local PC. |
|
54 * For a specific task, create a branch on this clone and check your changes |
|
55 into this branch. |
|
56 * Push those changes back to your "origin" (back up to github). |
|
57 |
|
58 **Build YUI** |
|
59 * See [Building YUI](https://github.com/yui/yui3/wiki/Developer-Workflow#building-yui). |
|
60 |
|
61 **Pull Request** |
|
62 * See [Making a change to YUI](https://github.com/yui/yui3/wiki/Developer-Workflow#making-a-change-to-yui). |
|
63 * Issue a pull request from your special branch via github to the yui/yui3 repo. |
|
64 * Make sure your pull request is against `dev-3.x` or `dev-master` **not** `3.x` or `master`. |
|
65 * `dev-master` is for small changes or bugfixes. `dev-3.x` is for bigger |
|
66 features or updates. (For more details see |
|
67 [Branch Information](https://github.com/yui/yui3/wiki/Developer-Workflow#branch-information) ) |
|
68 * Be sure your pull request meets the |
|
69 [Contribution Standards](https://github.com/yui/yui3/wiki/Contribution-Standards). |
|
70 |
|
71 **Other Resources** |
|
72 * [Contribute Code to YUI](http://yuilibrary.com/yui/docs/tutorials/contribute/) |
|
73 |
|
74 Pull Request Requirements |
|
75 ------------------------- |
|
76 **If you are making a pull request now please take note of the following |
|
77 requirements that your pull request needs (from Contribution Standards, above):** |
|
78 |
|
79 * Complete API Docs and inline code comments |
|
80 * Unit tests with 80% line coverage |
|
81 * User Guide (Components only) |
|
82 * Functional examples, written up in Selleck format and with test automation |
|
83 (https://github.com/yui/yui3/wiki/Selleck-Example-Tests) |
|
84 * Proper commit logs |
|
85 * Proper updates to HISTORY.md |