Skip to content

Latest commit

 

History

History
213 lines (157 loc) · 8.49 KB

CONTRIBUTING.md

File metadata and controls

213 lines (157 loc) · 8.49 KB
Raw

Contributing to Angular Material

Code of Conduct

Help us keep Angular open and inclusive.

Please read and follow our Code of Conduct.


## Have a Question, Problem, or Idea?

If you have questions or ideas regarding Angular Material, please direct these to the Angular Material Forum.

Otherwise, do you:

1. Found a Bug or Issue?

If you find a bug in the source code or a mistake in the documentation, we recommend that you first review the Online Documentation.

Otherwise you can help us improve by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix. Your custom changes can be crafted in a repository fork and submitted to the GitHub Repository as a Pull Request.

Important: Please review the Submission Guidelines below, before contributing to the project.

2. Want a Feature?

You can request a new feature by submitting an issue. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first on our Angular Material Forum, so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Changes can be crafted and submitted to the GitHub Repository as a Pull Request.

Issue Guidelines

Please note, this project is still in an early beta.

We're not actively reviewing unsolicited PRs from the community, although we welcome your feature requests, doc corrections, and issue reports. If you're thinking of contributing code or docs to the project, please review Submitting Pull Requests before beginning any work.

Submitting an Issue

Before you submit your issue, search the issues archive; maybe your question was already answered. If your issue appears to be a bug, and hasn't been reported, open a new issue.

Do not report duplicate issues; help us maximize the effort we can spend fixing issues and adding new features.

Providing the following information will increase the chances of your issue being dealt with quickly:

  • Issue Title - provide a concise issue title prefixed with a lower camelCase name of the associated target or component (if any): <component>: <issue title>.

    e.g.

    • mdSideNav: Adding swipe functionality #35
    • mdTextFloat: does not set required/ng-required #847

  • Overview of the Issue - if an error is being thrown, a non-minified stack trace helps.

  • Angular Material Version - check the header of your angular-material.js file to determine your specific version #.

/*!
 * Angular Material Design
 * https://github.com/angular/material
 * @license MIT
 * v0.6.0-rc1-master-57f10f7
 */
  • Browsers and Operating System - is this a problem with all browsers or only IE?
  • Reproduce the Error - provide a live example (using CodePen, Plunker, JSFiddle).
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit).

    Here are two examples of well-defined issues:

Submitting Pull Requests

Important: With the exception of minor bugs and doc fixes, we are not actively reviewing unsolicited PRs to Angular Material.

Please check with us via the discussion forum before investing significant effort in a planned Pull Request submission; it's likely that we are already working on a related PR.

  • All contributions must be consistent with the Angular Material coding conventions. See the Coding Guidelines
  • Submit proposed changes or additions as GitHub pull requests. See the Pull Request Guidelines

## Git Commit 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. It is important to note that we use the git commit messages to generate the Angular Material Changelog document.

A detailed explanation of guidelines and conventions can be found in this document.

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 nor adds a feature
  • perf: A code change that improves performance
  • 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 the place of the commit change.

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.

Breaking Changes are intended to highlight (in the ChangeLog) changes that will require community users to modify their code with this commit.


##### Sample Commit message: 
refactor(content): prefix mdContent scroll- attributes

    BREAKING CHANGE: md-content's `scroll-` attributes are now prefixed with `md-`.

    Change your code from this:

    ```html
    <md-content scroll-x scroll-y scroll-xy>
    ```

    To this:

    ```html
    <md-content md-scroll-x md-scroll-y md-scroll-xy>
    ```

## Guidelines for Developer Commit Authorizations

Please review the Commit Level and Authorization Guidelines for details on how to implement and submit your fixes, changes, or enchancements to Angular Material. This guideline provides details on creating a repository Fork of the Angular Material repository and how to submit Pull Requests.


## Signing the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!

To learn more and sign the CLA, visit cla.developers.google.com.