Skip to content
Newer
Older
100644 99 lines (58 sloc) 5.22 KB
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
1 # Contributing
2
3 We are more than happy to accept external contributions to the project in the form of feedback, bug reports and even better - pull requests :) At this time we are primarily focusing on improving the user-experience and stability of Yeoman for our first release. Please keep this in mind if submitting feature requests, which we're happy to consider for future versions.
4
5
a4ff2ea @sindresorhus readme: Also move the issue submission guidelines
sindresorhus authored
6 ## Issue submission
7
8 In order for us to help you please check that you've completed the following steps:
9
10 * Made sure you're on the latest version `npm update -g yeoman`
11 * Looked through the list of [known bugs](https://github.com/yeoman/yeoman/wiki/Additional-FAQ) to ensure the issue hasn't been noted or solved already
12 * Used the search feature to ensure that the bug hasn't been reported before
13 * Included as much information about the bug as possible, including any output you've received, what OS and version you're on, etc.
14 * Shared the output from `echo $PATH $NODE_PATH` and `brew doctor` as this can also help track down the issue.
15
16
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
17 ## Repos
18
19 Yeoman has three primary repos:
20
21 * [main project](http://github.com/yeoman/yeoman)
22 * [generators](http://github.com/yeoman/generators)
23 * [yeoman.io](http://github.com/yeoman/yeoman.io)
24
25
433da97 @paulirish Add section about CLA
paulirish authored
26 ## Contributor License Agreement
27
28 We'd love to accept your code patches! However, before we can take them, we have to jump a couple of legal hurdles.
29
bec878f @paulirish extra detail on the CLA
paulirish authored
30 We need you to sign a CLA. In summary, the CLA asserts that when you donate fixes or documentation, you both own the code that you're submitting and that Google can in turn license that code to other people. (In this case, making it available under the BSD license)
31
32 Just FWIW, here are some other projects that require a similar agreement: jQuery, Firefox, Sizzle, Dojo, Plone, Fedora, Cordova/Phonegap, Apache, Flex.
33
433da97 @paulirish Add section about CLA
paulirish authored
34 **Please fill out an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).** There is a web form at the bottom; shouldn't take too long.
35
36 (If you work for a company that wants to allow you to contribute, you'll need to complete a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).)
37
bec878f @paulirish extra detail on the CLA
paulirish authored
38 More about CLAs:
39 * http://wiki.civiccommons.org/Contributor_Agreements
40 * http://incubator.apache.org/ip-clearance/index.html
41 * http://dojofoundation.org/about/cla
433da97 @paulirish Add section about CLA
paulirish authored
42
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
43 ## Quick Start
44
45 * Clone this repo and `cd` into it
46 * Run this command: `./setup/install.sh`
47 * `cd` into the `/cli` directory and run `sudo npm link` after the install is complete.
48 * Navigate to a new directory and run `yeoman init` to make sure everything is working as expected.
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
49 * Add `yeoman_test` with any value to your environment variables to disable the updater and Insight.
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
50
51 You can keep Yeoman up to date by using `git pull --rebase upstream master && cd cli && npm link`, where `upstream` is a remote pointing to this repo.
52
b59819c @sindresorhus Add instructions on how to develop on the generators repo
sindresorhus authored
53 ### Generators
54
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
55 When developing in the generators repo you probably want to be able to test out your changes. The recommended workflow is to link the generators module into the yeoman project by running `npm link path/to/generator/folder` in `yeoman/cli/`. This means changes you do in the generators repo will be reflected in the yeoman repo.
b59819c @sindresorhus Add instructions on how to develop on the generators repo
sindresorhus authored
56
138ce77 @addyosmani Fixes #619 - adds note to contrib. guide about the new --disable-insi…
addyosmani authored
57 ### Insight
58
59 When developing for Yeoman, you will most likely be running and debugging commands within the CLI. If you have opted into Insight, these commands will be logged. A special `--disable-insight` flag is available for developers wishing to opt out of Insight tracking so inflated stats are not recorded.
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
60
61 ## Style Guide
62
63 This project uses single-quotes, two space indentation, multiple var statements and whitespace around arguments. Please ensure any pull requests follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this.
64
65
66 ## Pull Request Guidelines
67
433da97 @paulirish Add section about CLA
paulirish authored
68 * Submit your CLA, if you haven't.
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
69 * Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned. We also recommend checking for issues related to the issue on the tracker, as a team member may be working on the issue in a branch or fork.
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
70 * Non-trivial changes should be discussed in an issue first
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
71 * Develop in a topic branch, not master
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
72 * Lint the code by running `grunt` in the `/cli` folder
73 * Add relevant tests to cover the change
74 * Make sure test-suite passes
75 * Squash your commits
76 * Write a convincing description of your PR and why we should land it
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
77
78
79 ## Tests
80
81 Yeoman has a test suite to ensure it's reliably and accurately working as a developer tool. You can find the main test suite in [`test/test-build.js`](https://github.com/yeoman/yeoman/blob/master/cli/test/test-build.js), most of the assertions are [checks against yeoman cli stdout](https://github.com/mklabs/yeoman/wiki/test-build).
82
83 To run our test suite:
84
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
85 ```
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
86 npm test
87 ```
88
89 Do note that if any CLI prompts are not accounted for the test suite will have a timeout failure.
90
91
92 ## Developer Docs
93
94 We have significant developer docs for you if you'd like to hack on Yeoman.
95
96 Currently you can find much of the details on [mklabs' yeoman wiki](https://github.com/mklabs/yeoman/wiki/_pages) but also [our primary project](https://github.com/yeoman/yeoman/tree/master/docs/cli).
97
98 You're also welcome to `git blame` back to commit messages and pull requests. As a project we value comprehensive discussion for our fellow developers.
Something went wrong with that request. Please try again.