Skip to content

Latest commit

 

History

History
225 lines (163 loc) · 8.84 KB

CONTRIBUTING.md

File metadata and controls

225 lines (163 loc) · 8.84 KB

Contributing

Code of Conduct

Help us keep the app open and inclusive. Please read and follow our Code of Conduct.

Got a Question or Problem?

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our Repository]. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario. Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions.

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.

You can file new issues by filling out our new issue form.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search for an open or closed PR that relates to your submission. You don't want to duplicate effort.
  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.
  3. Make your changes in a new git branch:
  git checkout -b my-fix-branch master
  1. Create your patch, including appropriate test cases.
  2. Follow our Coding Rules.
  3. Run the full Angular test suite, as described in the developer documentation, and ensure that all tests pass.
  4. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
  git commit -a
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
  1. Push your branch to GitHub:
  git push origin my-fix-branch
  1. In GitHub, send a pull request to :master.
  • If we suggest changes then:
    • Make the required updates.
    • Re-run the Angular test suites to ensure tests are still passing.
    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
  git rebase master -i
  git push -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
  git push origin --delete my-fix-branch
  • Check out the master branch:
  git checkout master -f
  • Delete the local branch:
  git branch -D my-fix-branch
  • Update your master with the latest upstream version:
  git pull --ff upstream master

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All public API methods must be documented. (Details TBC).
  • We follow Google's JavaScript Style Guide, but wrap all code at 100 characters. An automated formatter is available, see DEVELOPER.md.

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

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>: <subject>
  <BLANK LINE>
  <body>
  <BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

The header of the commit cannot be longer than 50 characters, and lines of the commit message cannot be longer 72 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Commit message template

#                Header (up to 50)              #
 
 
#                Body (up to 72)                                       #

 

# Description of changes. Answer the following questions:
# - Why is this change necessary?
# - How does it address the issue?
# - What side effects does this change have?

The footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs: update changelog to beta.5

fix: need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the 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.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this document.