Skip to content


Subversion checkout URL

You can clone with
Download ZIP
100644 86 lines (64 sloc) 3.54 KB
a24db5c @reid Add
reid authored
1 # Contribute to Yeti
3 Yeti is built by the YUI Team at Yahoo! and contributors like you. We are excited
4 that you are interested in improving Yeti with us. This guide will help make sure
5 your contribution will be ready to ship.
7 If you are considering larger changes to Yeti, please discuss your proposed change
8 on the [Yeti Forums][forums] to coordinate effort and get feedback from Yeti users.
9 For small changes and bugfixes, opening a bug (if it does not already exist) and
10 posting that you're working on it is just fine. Thank you!
12 ## Getting Started
14 1. Make sure you have a [][yui] account.
15 - We use this to track Yeti bugs and contributor CLAs.
16 - Sign up with the same e-mail address you use in your Git commit messages.
17 - Using the same address allows us to verify your [CLA][] is on file.
18 1. Make sure you have a [][gh] account.
19 1. [Submit a ticket][newticket] for your issue, if it does not already exist.
20 - Check [Yeti's open issues][issues] to see if your issue was already reported.
21 1. Post a comment on the issue's ticket noting that you plan to work on it.
22 1. Fork the [Yeti repository][repo] on GitHub.
24 ## Making Changes
26 1. Run `npm test` before making changes to make sure your setup is working.
27 1. Create a topic branch for your contribution.
28 - This is usually based off master.
29 You can create a topic with `git checkout -b my-bugfix-branch-name`
30 1. Make commits that describe a single logical change. See the example below.
31 1. Run `git diff --check` and remove unnecessary whitespace.
32 1. Run `make lint` and make sure your new code runs through the linter
33 without error.
34 1. Run `make coverage` and make sure your new code is covered with a test.
35 Tests are located in `test` and use [Vows][].
36 1. Make sure all existing tests pass.
38 ### Example Commit Message
40 Provide example. 50 chars, present-tense. Fix #1.
42 Detailed explanatory text, if necessary. Be clear and concise.
43 Wrap text to about 72 characters. The blank line between the
44 summary and body is important; Git tools expect the blank line
45 and may not behave correctly if it's omitted. Sometimes the first
46 line is treated as the subject of the email and the rest as the body.
48 Write your commit message in the present tense: "Fix foo" and not "Fixed
49 foo." This convention matches the commit messages generated by tools
50 like git merge and git revert.
52 Include the bug number in your summary, e.g. "Fix #1."
54 Further paragraphs come after blank lines.
56 - You can also create lists with bullet points.
58 - A hyphen is used for the bullet, preceded by a single space, with
59 blank lines in between.
61 - Use a hanging indent.
63 ## Submitting Changes
65 1. Sign the [YUI Contributor License Agreement][CLA].
66 1. Push your changes to a topic branch in your fork of the repository.
67 1. Submit a pull request to the repositiory in the yui organization.
68 1. Update your ticket with the URL of your pull request.
70 ## Get Help
72 - [](
73 - [Yeti Forums][forums]
74 - #yui on [](
76 Thanks for working to make Yeti better. We really, really appreciate it!
78 [forums]:
79 [CLA]:
80 [yui]:
81 [gh]:
82 [issues]:
83 [newticket]:
84 [repo]:
85 [Vows]:
Something went wrong with that request. Please try again.