Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 55 lines (34 sloc) 2.651 kb
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
1 # Contributing
2
a9d4059 @eddiemonge remove first release focus
eddiemonge authored
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 :)
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
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
f07c3df @sindresorhus Rewrite contributing.md for 1.0
sindresorhus authored
10 * Made sure you're on the latest version `npm update -g yo`
a4ff2ea @sindresorhus 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 @danielchatfield 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 @sindresorhus readme: Also move the issue submission guidelines
sindresorhus authored
14
dddca0f @danielchatfield 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 @danielchatfield 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 @sindresorhus Massively improve the readme. Make it more focused.
sindresorhus authored
19 [Submit your issue](https://github.com/yeoman/yeoman/issues/new)
20
a4ff2ea @sindresorhus readme: Also move the issue submission guidelines
sindresorhus authored
21
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
22 ## Quick Start
23
8f51da3 @eddiemonge add links to repos
eddiemonge authored
24 - Clone the repo of [yo](https://github.com/yeoman/yo), [generator](https://github.com/yeoman/generator), and any generator you might want to develop against, and then run `npm install` in them.
5f9ac59 @sindresorhus Update contributing.md
sindresorhus authored
25 - 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 @sindresorhus Rewrite contributing.md for 1.0
sindresorhus authored
26 - Run `yo` and you should now see the linked generators in the list.
27 - Start hacking :)
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
28
f07c3df @sindresorhus Rewrite contributing.md for 1.0
sindresorhus authored
29 You can keep the various repos up to date by running `git pull --rebase upstream master` in each.
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
30
aeed6eb @sindresorhus Massively improve the readme. Make it more focused.
sindresorhus authored
31
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
32 ## Style Guide
33
b14d86a @robdodson Style guide tweaks
robdodson authored
34 This project uses single-quotes, two space indentation, multiple var statements and whitespace around arguments. Use a single space after keywords like `function`. Ex:
35
36 ```
37 function () { ... }
38 function foo() { ... }
39 ```
40
41 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 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
42
43
44 ## Pull Request Guidelines
45
46 * 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
47 * Non-trivial changes should be discussed in an issue first
f1e2ea8 @sindresorhus Move the contribute section into a contributing.md file
sindresorhus authored
48 * Develop in a topic branch, not master
f07c3df @sindresorhus Rewrite contributing.md for 1.0
sindresorhus authored
49 * Lint the code by running `grunt`
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
50 * Add relevant tests to cover the change
f07c3df @sindresorhus Rewrite contributing.md for 1.0
sindresorhus authored
51 * Make sure test-suite passes: `npm test`
fc8e04b @sindresorhus Improve contributing.md. Fixes #279
sindresorhus authored
52 * Squash your commits
53 * Write a convincing description of your PR and why we should land it
757a72a @eddiemonge update guidelines section
eddiemonge authored
54 * Check the indvidual project to see if there is a **contributing.md** or similar file as some project's have different requirements.
Something went wrong with that request. Please try again.