Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 69 lines (41 sloc) 3.435 kb
f1e2ea8 Sindre Sorhus 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 Sindre Sorhus 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
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
10 * Made sure you're on the latest version `npm update -g yo`
a4ff2ea Sindre Sorhus readme: Also move the issue submission guidelines
sindresorhus authored
11 * Used the search feature to ensure that the bug hasn't been reported before
12 * Included as much information about the bug as possible, including any output you've received, what OS and version you're on, etc.
dddca0f Daniel Chatfield Add windows command
danielchatfield authored
13 * Shared the output from running the following command in your project root as this can also help track down the issue.
a4ff2ea Sindre Sorhus readme: Also move the issue submission guidelines
sindresorhus authored
14
dddca0f Daniel Chatfield Add windows command
danielchatfield authored
15 Unix: `yo --version && echo $PATH $NODE_PATH && node -e 'console.log(process.platform, process.versions)' && cat Gruntfile.js`
16
30ba384 Daniel Chatfield Add newline
danielchatfield authored
17 Windows: `yo --version && echo %PATH% %NODE_PATH% && node -e "console.log(process.platform, process.versions)" && type Gruntfile.js`
18
aeed6eb Sindre Sorhus Massively improve the readme. Make it more focused.
sindresorhus authored
19 [Submit your issue](https://github.com/yeoman/yeoman/issues/new)
20
a4ff2ea Sindre Sorhus readme: Also move the issue submission guidelines
sindresorhus authored
21
433da97 Paul Irish Add section about CLA
paulirish authored
22 ## Contributor License Agreement
23
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
24 Before we can accept patches, there's a quick web form we need you to fill out [here](http://code.google.com/legal/individual-cla-v1.0.html) (**scroll to the bottom!**).
433da97 Paul Irish Add section about CLA
paulirish authored
25
533c17c Devin Rhode Re-wrote CLA section to get to the point.
devinrhode2 authored
26 If you're contributing under a company, you need to fill out [this form instead](http://code.google.com/legal/corporate-cla-v1.0.html).
bec878f Paul Irish extra detail on the CLA
paulirish authored
27
533c17c Devin Rhode Re-wrote CLA section to get to the point.
devinrhode2 authored
28 This CLA asserts that fixes and documentation are owned by you and that Google can license all work under BSD.
bec878f Paul Irish extra detail on the CLA
paulirish authored
29
533c17c Devin Rhode Re-wrote CLA section to get to the point.
devinrhode2 authored
30 Other projects require a similar agreement: jQuery, Firefox, Apache, and many more.
433da97 Paul Irish Add section about CLA
paulirish authored
31
533c17c Devin Rhode Re-wrote CLA section to get to the point.
devinrhode2 authored
32 [More about CLAs](https://www.google.com/search?q=Contributor%20License%20Agreement)
433da97 Paul Irish Add section about CLA
paulirish authored
33
aeed6eb Sindre Sorhus Massively improve the readme. Make it more focused.
sindresorhus authored
34
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
35 ## Quick Start
36
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
37 - Add `yeoman_test` with any value to your environment variables to disable the updater and Insight.
5f9ac59 Sindre Sorhus Update contributing.md
sindresorhus authored
38 - Clone the repo of yo, generator, and any generator you might want to develop against, and then run `npm install` in them.
39 - Go to the yo folder and link it globally using `npm link` then link in the generators using `npm link path/to/generator` for each.
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
40 - Run `yo` and you should now see the linked generators in the list.
41 - Start hacking :)
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
42
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
43 You can keep the various repos up to date by running `git pull --rebase upstream master` in each.
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
44
aeed6eb Sindre Sorhus Massively improve the readme. Make it more focused.
sindresorhus authored
45
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
46 ## Style Guide
47
b14d86a Rob Dodson Style guide tweaks
robdodson authored
48 This project uses single-quotes, two space indentation, multiple var statements and whitespace around arguments. Use a single space after keywords like `function`. Ex:
49
50 ```
51 function () { ... }
52 function foo() { ... }
53 ```
54
55 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.
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
56
57
58 ## Pull Request Guidelines
59
433da97 Paul Irish Add section about CLA
paulirish authored
60 * Submit your CLA, if you haven't.
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
61 * 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 Sindre Sorhus Improve contributing.md. Fixes #279
sindresorhus authored
62 * Non-trivial changes should be discussed in an issue first
f1e2ea8 Sindre Sorhus Move the contribute section into a contributing.md file
sindresorhus authored
63 * Develop in a topic branch, not master
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
64 * Lint the code by running `grunt`
fc8e04b Sindre Sorhus Improve contributing.md. Fixes #279
sindresorhus authored
65 * Add relevant tests to cover the change
f07c3df Sindre Sorhus Rewrite contributing.md for 1.0
sindresorhus authored
66 * Make sure test-suite passes: `npm test`
fc8e04b Sindre Sorhus Improve contributing.md. Fixes #279
sindresorhus authored
67 * Squash your commits
68 * Write a convincing description of your PR and why we should land it
Something went wrong with that request. Please try again.