Contributing

It can sometimes be hard to know where to start contributing when looking at a large project like Yeoman. This document will try to layout the project organization and the different ways you can help us!

Community

The easiest way to start is probably to get involved with our community.

Documentation

The most time consuming task of most open source projects is writing and updating documentation. This include the core docs, but also help maintaining and updating the Website.

Chances are you're probably a web developer. If so that's awesome because there's a lot to do making this website better.

Head to yeoman/yeoman.github.io to work on the website and documentation.

Official Generators

The core yeoman team maintains a lot of official generators. You like frameworks? You use one of our generators and have some ideas on how to improve it? Then really this is where you should start!

Checkout out our github organization to find the repository you'd like to contribute to.

The plugins and modules

The core team maintains a couple node modules and a bunch of Grunt plugins.

The core system

Once you're familiar with the way Yeoman works - or if you just want to work with Node.js - then you might want to contribute to the core system.

There's basically three components to the core system:

  1. yo, the command line interface to use Yeoman.
  2. The environment, which finds, registers, and runs the generators.
  3. The base classes you extend to create your own generators. Those classes contain the helper methods to ease the authoring of your own generators.