Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 4.5 KB

contributing.md

File metadata and controls

104 lines (75 loc) · 4.5 KB
Raw

Contributing

See the Yeoman contributing docs

Additionally for this generator:

  • Please submit bug fix PRs to the master branch. Please submit large feature PRs to the canary branch; it is the main development branch for this generator.
  • When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
  • When submitting a PR, make sure that the commit messages match the AngularJS conventions (see below).
  • When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
  • When submitting a new feature, add tests that cover the feature.
  • Open Issues marked with the EASY label are believed to be easy changes, and would be good Issues to tackle for new contributors.

This project has 2 main branches: master and canary. The master branch is where the current stable code lives and should be used for production setups. The canary branch is the main development branch, this is where PRs should be submitted to (backport fixes may be applied to master).

By separating the current stable code from the cutting-edge development we hope to provide a stable and efficient workflow for users and developers alike.

When submitting a PR, make sure that the commit messages match the AngularJS conventions.

When submitting a bugfix, try to write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

When submitting a new feature, add tests that cover the feature.

To run the generator:

  1. Clone it and cd to its root
  2. npm install
  3. npm link (tells npm to look to your own version)
  4. yo angular-fullstack as normal. It should run from your cloned version rather than the one downloaded from npm.

Git Commit Guidelines

These rules are adopted from the AngularJS project.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug or adds a feature
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope could be anything specifying place of the commit change. For example app, gen, docs, gen:view, gen:route, gen:service, etc...

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

###Body Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes" The body should include the motivation for the change and contrast this with previous behavior.

###Footer The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

A detailed explanation can be found in this document.

Releasing

(for contributors with push access)

The grunt release task will do most of the work for you, see grunt-release for valid release targets.

  • Run the release task grunt release:RELEASE_TARGET.

  • Push and publish the angular-fullstack-deps submodule.

$ cd angular-fullstack-deps
$ git push && npm publish
$ cd ..
  • Push and publish generator-angular-fullstack.
$ git push && git push --tags
$ npm publish