Skip to content

Latest commit

 

History

History
167 lines (123 loc) · 6.39 KB

CONTRIBUTING.md

File metadata and controls

167 lines (123 loc) · 6.39 KB
Raw

Got a Question or Problem?

If you have questions about how to use AngularDart, please direct them to the Dart Web Group discussion list or Stack Overflow.

Found an Issue?

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

Want 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.

  • 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.
  • Small Features can be sent directly as a pull request.

Submission Guidelines

Submitting an Issue

Before you submit an issue, search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Angular Version - what version of Angular is affected (e.g. 2.0.0)
  • Motivation or Use Case - explain what are you trying to do and why the current behavior is a bug for you
  • Browsers and Operating System - is this a problem with all browsers?
  • Reproduce the Error - provide an unambiguous set of steps
  • 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)

You can file new issues by providing the above information.

Submitting a Pull Request (PR)

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

  • Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
  • Please sign our Contributor License Agreement (CLA) before sending PRs. We cannot accept code without this.

As mentioned above, Pull Request should generally be small in scope. Anything more complex should start as an issue instead. Some examples of types of pull requests that are immediately helpful:

  • Fixing a bug without changing the public API.
  • Fixing or improving documentation.

Merging pull requests

Due to the fact that Angular Dart is developed as a subset of Google's internal codebase (which is automatically synced to the public GitHub repository), we are unable to merge pull requests directly into the master branch. Instead, once a pull request is ready for merging, we'll make the appropriate changes in the internal codebase and, when the change is synced out, give the pull request author credit for the commit.

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!

Running travis

Our automated tests on Travis check the following:

  • dartanalyzer (static analysis), failing on any errors or warnings.
  • Unit tests (in the VM, Dart2JS, and DartDev).

Due to a complex set of packages, we have a more complex travis setup that is utilizing build stages. In order to run tests locally, use the following script (on POSIX systems):

bash tool/presubmit.sh

Or, you may specify individual testing tasks:

$ PKG=<pkg> tool/travis.sh <task>

Valid packages (<pkg>) include:

  • _benchmarks
  • _goldens
  • _tests
  • angular
  • angular_ast
  • angular_compiler
  • angular_forms
  • angular_router
  • angular_test
  • examples/github_issues
  • examples/hacker_news_pwa
  • examples/hello_world
  • examples/registration_form

Valid tasks (<task>) include:

  • analyze (Runs dartanalyzer --fatal-warnings .)
  • build (Runs pub run build_runner build --fail-on-severe)
  • build:release (Runs pub run build_runner build --config=release --fail-on-severe)
  • test (Runs pub run build_runner test --fail-on-severe -- -r expanded -x fails-on-travis)
  • test:release (Runs pub run build_runner test --config=release --fail-on-severe -- -r expanded -x fails-on-travis)

Some example runs:

# Runs the analyzer on package:angular.
PKG=angular tool/travis.sh analyze

# Runs tests with DDC on package:_tests.
PKG=_tests tool/travis.sh test

# Runs tests with the Dart VM on package:angular_compiler.
PKG=angular_compiler tool/travis.sh test

To regenerate the .travis.yml script, see dev/README.md#travis.

NOTE: We recommend running with dartfmt before sending pull-requests, but do not validate on Travis as our source of truth is internal at Google, with a possible version skew on dartfmt output.

Custom SDK

To use a custom version of the SDK while testing (for example, when testing edge releases of the SDK), pass an SDK= environment variable that points to the bin directory of your SDK. For example:

SDK=/tmp/some/edge/sdk/bin PKG=_tests tool/travis.sh build