How to Contribute
Contributing is easy. Follow the steps below.
- Find an issue to fix on the issues page. If you have an idea that's not listed go ahead and create a new issue to discuss it.
- Comment on the issue that you're interested in taking ownership of. Include details of your proposed changes.
- One of the contributors will comment back and eventually assign the item to you
The code for the yeoman generator is located at index.js. If you need to make changes to that make them in a feature branch and send changes in a PR to the master branch. A contributor will comment back and eventually merge the changes. On release these changes will be merged to the release branch and the npm package will be updated.
The templates for the project types are stored in the /samples directory and each subgenerator has its own directory.
If you make changes or additions to the generator, make sure that the existing tests in the /tests directory are also edited OR new tests are added to cover the new functionality and the tests pass.
You should make changes in a new feature branch and test them locally. When testing locally if you run the samples from the source directory make sure not to check in any files which are not needed. All files in the repo will be created in the project when the generator is used. Because of this you should not check in files like .gitignore.
When your changes are in good shape submit a PR and reference the issue that it relates to. One of the contributors will comment on the PR/issue and eventually merge it.
The project repository contains configuration files to maintain consistent code styles in source code. At the moment source code styles are not enforced but you are welcome to use them and help us to avoid merge or rebase conflicts.
You are advised to use your code editor of choice feature to apply code style formatting and use EditorConfig project extension within your editor:
The JavaScript source code for generator can be linted with JSHint extension and you are welcome to lint existing and new code according to project settings.