Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 1.69 KB

Contributing

Creating Issues

To file bug reports and feature suggestions, use the "Issues" page.

  1. Make sure the issue has not been filed before.
  2. Create a new issue by filling out the issue form.
  3. If an issue requires more information and receives no further input, it will be closed.

Creating Pull Requests

To create pull requests, use the "Pull Requests" page.

  1. Create a new Issue describing the Bug or Feature you are addressing, to let others know you are working on it.
  2. If a related issue exists, add a comment to let others know that you'll submit a pull request.
  3. Create a new pull request by filling out the pull request form.

Setup

  1. Fork the repository.
  2. Clone your fork.
  3. Make a branch for your change.
  4. Run npm install.

Commit Message

Use the AngularJS commit message format:

type(scope): subject

type

  • feat New feature
  • fix A bugfix
  • refactor Code changes which are neither bugfix nor feature
  • docs: Documentation changes
  • test: New tests or changes to existing tests
  • chore: Changes to tooling or library changes

scope

The context of the changes, e.g. preferences-window or compiler. Use consistent names.

subject

A brief, yet descriptive description of the changes, using the following format:

  • present tense
  • lowercase
  • no period at the end
  • describe what the commit does
  • reference to issues via their id – e.g. (#1337)