Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.19 KB
Raw

Contributing to Playbook

Submitting Issues

If Playbook is exhibiting unexpected behavior, please file an issue that allows the maintainers to reproduce the results you see. You may also use issues to submit feature requests.

  1. Pick a title that describes intent clearly
  2. Describe in as much detail as possible the steps you took to reach the unexpected behavior
  3. Describe the unexpected behavior (e.g. – a stack trace with the error or a screen shot)
  4. Describe the expected behavior
  5. Please describe your environment (e.g. – versions of OS, Ruby, Node and Playbook you are using)

Development Flow

  1. Clone the repository
  2. Make your changes in a topic branch
  3. Rebase against origin/master
  4. Submit a pull request

Linking Playbook

In order to see and test the changes you've made to Playbook, you'll need to uninstall any previously installed versions of Playbook and link your local Playbook.

  1. npm uninstall -g generator-playbook
  2. cd path/to/playbook/repo
  3. npm link
  4. cd path/to/desired/location
  5. yo playbook

The resulting Playbook generator will be referencing your local copy of the Playbook repository rather than an installed published release.

Git Commit Messages

  • Capitalize your commit messages
  • Start your message with a verb
  • Use present tense
  • Refer to the issue/PR number in your squashed commit message

Tagging and Publishing Releases

  1. Update the package version in package.json. This should match the version number that you intend to publish to npmjs.org.
  2. Commit your version bump: git commit -am "Prepare #.#.# release"
  3. Create an annoted git tag for the release: git tag -a v#.#.# -m "Version #.#.#"
  4. Push master/tags: git push origin master --tags
  5. Publish to npm: npm publish

NOTE: Playbook is using semver. Do not break this pattern.