readme.md

Welcome, Friend!

What am I?

Yeoman is a robust and opinionated client-side stack, comprised of tools and frameworks that can help developers quickly build beautiful web applications. We take care of providing everything needed to get started without any of the normal headaches associated with a manual setup.

Yeoman is fast, performant and is optimized to work best in modern browsers.

Issue submission

In order for us to help you please check that you've completed the following steps:

Made sure you're on the latest version

Read our documentation and README to ensure the issue hasn't been noted or solved already

Used the search feature to ensure that the bug hasn't been reported before

Included as much information about the bug as possible, including any output you've received, what OS and version you're on.

Shared the output from echo $PATH $NODE_PATH and brew doctor as this can also help track down the issue.

Then open a new issue and one of the team will be happy to follow up with you.

Bower

Yeoman uses Bower as its package manager. The Bower registry is currently being populated, you may find that certain packages work and others do not. We are actively working with the Bower team to resolve this issue and hope to have fully functional packages in place upon launch.

Browser Support

Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)

Chrome on Android

Mobile Safari

Platform Support

Yeoman 1.0 will support OS X and Linux. We will be aiming to bring in support for Windows in a future version of the project.

Contribute

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.

Repos

Quick Start

cd into the /cli directory and run sudo npm link after the install is complete.

Navigate to a new directory and run yeoman init to make sure everything is working as expected.

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.

Style Guide

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.

Pull Request Guidelines

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.

Lint the code by running grunt in the /cli folder before submitting a pull request