Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 130 lines (95 sloc) 5.844 kb
ae08c94 @clarle README: remove Y! bang
clarle authored
1 YUI 3: The Yahoo User Interface Library
2 =======================================
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
3
4ca3778 @okuryu SVG Build Status Badge
okuryu authored
4 [![Build Status](https://travis-ci.org/yui/yui3.svg?branch=master)](https://travis-ci.org/yui/yui3)
7177f61 @okuryu Update README
okuryu authored
5
1ce0e0d @rgrove Update readme.
rgrove authored
6 YUI is a free, open source JavaScript and CSS framework for building richly
7 interactive web applications. YUI is provided under a BSD license and is
8 available on GitHub for forking and contribution.
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
9
1ce0e0d @rgrove Update readme.
rgrove authored
10 Links
11 -----
12
13 * [Home Page](http://yuilibrary.com/)
14 * [Documentation](http://yuilibrary.com/yui/docs/)
007effa @triptych Updating Links and Branch Info.
triptych authored
15 * [Blog](http://yuiblog.com)
1ce0e0d @rgrove Update readme.
rgrove authored
16 * [Latest Production Release](http://yuilibrary.com/download/yui3/)
7177f61 @okuryu Update README
okuryu authored
17 * [Forums](https://groups.google.com/forum/#!forum/yui-support)
1ce0e0d @rgrove Update readme.
rgrove authored
18 * [License](http://yuilibrary.com/license/)
7177f61 @okuryu Update README
okuryu authored
19 * [Contributor Info](https://github.com/yui/yui3/blob/master/CONTRIBUTING.md)
007effa @triptych Updating Links and Branch Info.
triptych authored
20 * [Contributor Mailing List](https://groups.google.com/forum/?fromgroups#!forum/yui-contrib)
1ce0e0d @rgrove Update readme.
rgrove authored
21 * [Report a Bug](http://yuilibrary.com/yui/docs/tutorials/report-bugs/)
e146098 @davglass Shifter link fixes
davglass authored
22 * [Shifter, for building YUI](http://yui.github.com/shifter/)
1ce0e0d @rgrove Update readme.
rgrove authored
23
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
24
1ce0e0d @rgrove Update readme.
rgrove authored
25 Source Info
26 -----------
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
27
28 This is the active working source tree for YUI 3. It contains work in progress
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
29 toward the next YUI 3 releases and may be unstable.
1ce0e0d @rgrove Update readme.
rgrove authored
30
31 We encourage you to use the latest source for evaluation purposes, testing new
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
32 features and bug fixes, and to provide feedback on new functionality. Please
33 refer to the "Latest Production Release" link above if you're looking for the
34 latest stable release of YUI recommended for production use.
35
007effa @triptych Updating Links and Branch Info.
triptych authored
36 If you plan on contributing to YUI, please join and monitor the "Contributor
37 Mailing List" listed above. Information about milestones and tree closures
38 will be made available there.
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
39
007effa @triptych Updating Links and Branch Info.
triptych authored
40
41 ## Branch Information
42
43 YUI's development happens on five main branches. The following describes what
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
44 each of these code branches represents:
45
007effa @triptych Updating Links and Branch Info.
triptych authored
46 * `live-docs`: Represents the latest GA release of YUI, plus any
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
47 documentation-only updates. Any tweaks or additions to the docs for the
48 latest release happen on this branch, and they are reflected on the website.
49
5b92713 @triptych format fix.
triptych authored
50 * `master`: (Read-only) Contains everything in `live-docs`, plus code changes that will go
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
51 into the next YUI release. The code changes in `master` are either bug fixes
52 or small changes which should not break API compatibility. Patch releases
007effa @triptych Updating Links and Branch Info.
triptych authored
53 will be cut from this branch; e.g. 3.6.x. *All code in this branch has fully
54 passed all unit tests and should be stable.*
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
55
5b92713 @triptych format fix.
triptych authored
56 * `3.x`: (Read-only) Represents the next major YUI release; e.g. 3.7.0. This is an
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
57 integration branch which contains everything in `master`, plus larger code
58 changes which will go into a future YUI release. The changes in `3.x`
007effa @triptych Updating Links and Branch Info.
triptych authored
59 require a minor version increment before they are part of release, e.g.,
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
60 3.7.0. Preview Releases will be cut from this branch for developers to test
007effa @triptych Updating Links and Branch Info.
triptych authored
61 and evaluate. *All code in this branch has fully passed all unit tests and should be stable.*
62
63 * `dev-master` and `dev-3.x`: Current working branches containing code that
49e4797 @triptych Syncing readme with wiki
triptych authored
64 **has not** been through the CI process. **Developers check their changes in to
65 these integration branches for the automated testing system to validate.** Once they
66 are validated, the code is merged into `master` and `3.x` respectively. **Never** check in to
67 `master` or `3.x` directly.
007effa @triptych Updating Links and Branch Info.
triptych authored
68
49e4797 @triptych Syncing readme with wiki
triptych authored
69 * `release-3.x.x`: Short-lived release branches where code checkins are carefully
70 managed for extensive testing and release deployment.
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
71
d8a462e @triptych Update heading indent.
triptych authored
72 ## Source Tree
c64ca74 @ericf Update README to reflect YUI's updated branching strategy.
ericf authored
73
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
74 The YUI source tree includes the following directories:
75
76 * `build`: Built YUI source files. The built files are generated at
77 development time from the contents of the `src` directory. The build step
78 generates debug files (unminified and with full comments and logging),
79 raw files (unminified, but without debug logging), and minified files
80 (suitable for production deployment and use).
1ce0e0d @rgrove Update readme.
rgrove authored
81
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
82 * `src` Raw unbuilt source code (JavaScript, CSS, image assets, ActionScript
83 files, etc.) for the library. Beginning with YUI 3.4.0, the `src` directory
84 also contains all module-specific documentation, tests and examples. All
85 modifications to the library and its documentation should take place in
86 this directory.
87
007effa @triptych Updating Links and Branch Info.
triptych authored
88 ## Initial Setup
89
ff23438 @okuryu [docs] Tweak README
okuryu authored
90 1. Fork the project on GitHub (https://github.com/yui/yui3).
007effa @triptych Updating Links and Branch Info.
triptych authored
91 1. Clone the fork to your local environment for development.
92
93 ## Do Good Stuff
94
95 1. Create a feature branch to house atomic code changes.
96 `git checkout -b myfeature upstream/master --no-track`
97 1. Satisfy the contribution requirements
98 (see [YUI Contribution Standards](https://github.com/yui/yui3/wiki/Contribution-Standards)).
99 1. Push changes to your fork.
100 1. Submit a pull request from your fork to the `live-docs`,
101 `dev-master`, or `dev-3.x` branch for review.
102 1. Incorporate community feedback.
103 1. Push changes to your fork -- the pull request will automatically update.
104 1. Rinse and repeat.
105
106 All changes should continue to be made on the feature branch; that way the pull
107 request you submit will automatically update to include them. Make sure to keep
108 the feature branch updated with the latest changes from master, so that they
109 don't diverge during your development process.
110
111 ## Important Tips
112
113 * Always work from a feature branch. Since all code submissions will be
114 through a Pull Request, feature branches isolate changes from one submission to another.
115 * Always start your new branch from the branch you want to submit to:
116 `git checkout -b myfeature dev-master`
117 * Remember to submit your Pull Request to the proper `dev-` branch and not
118 `master` or `3.x`.
119
120 ## Building
121
e146098 @davglass Shifter link fixes
davglass authored
122 To build YUI components install [Shifter](http://yui.github.com/shifter/) (`npm -g install shifter`)
8161c0d @jshirley Update README.md
jshirley authored
123 and then simply run `shifter` in that components directory.
124
125 Shifter also allows you to rebuild the entire YUI src tree:
126
127 cd yui3/src && shifter --walk
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
128
9fe3e47 @davglass Test Change
davglass authored
129
Something went wrong with that request. Please try again.