Skip to content

Latest commit

 

History

History
193 lines (133 loc) · 7.38 KB

CONTRIBUTING.md

File metadata and controls

193 lines (133 loc) · 7.38 KB
Raw

Questions

This is the issue tracker for Ember.js. The Ember.js community uses this site to collect and track bugs and discussions of new features. If you are having difficulties using Ember.js or have a question about usage, please ask a question on Stack Overflow: http://stackoverflow.com/questions/ask?tags=ember.js

The Ember.js community is very active on Stack Overflow and most questions receive attention the same day they're posted: http://stackoverflow.com/questions/tagged/ember.js

Issue Labeling

Ember uses StandardIssueLabels for Github Issues.

Issues

Think you've found a bug or have a new feature to suggest? Let us know!

Reporting a Bug

  1. Update to the most recent master release if possible. We may have already fixed your bug.

  2. Search for similar issues. It's possible somebody has encountered this bug already.

  3. Provide JSFiddle or JSBin demo that specifically shows the problem. This demo should be fully operational with the exception of the bug you want to demonstrate. The more pared down, the better. Preconfigured starting points for the latest Ember: JSFiddle | JSBin (may not work with older IE versions due to MIME type issues). If it is not possible to produce a fiddle, please make sure you provide very specific steps to reproduce the error. If we cannot reproduce it, we will close the ticket.

  4. Your issue will be verified. The provided example will be tested for correctness. The Ember team will work with you until your issue can be verified.

  5. Keep up to date with feedback from the Ember team on your ticket. Your ticket may be closed if it becomes stale.

  6. If possible, submit a Pull Request with a failing test. Better yet, take a stab at fixing the bug yourself if you can!

The more information you provide, the easier it is for us to validate that there is a bug and the faster we'll be able to take action.

Requesting a Feature

  1. Search Issues for similar feature requests. It's possible somebody has already asked for this feature or provided a pull request that we're still discussing.

  2. Provide a clear and detailed explanation of the feature you want and why it's important to add. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on library for Ember.

  3. If the feature is complex, consider writing some initial documentation for it. If we do end up accepting the feature it will need to be documented and this will also help us to understand it better ourselves.

  4. Attempt a Pull Request. If you're at all able, start writing some code. We always have more work to do than time to do it. If you can write some code then that will speed the process along.

Building Ember.js

Building Ember is quite simple.

cd ember.js
npm install
bower install
npm run-script build

Pull Requests

We love pull requests. Here's a quick guide:

  1. Fork the repo.

  2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: npm install && bower install && npm test. (To see tests in the browser, run npm start and open http://localhost:4200/tests/index.html.)

  3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test! If your change is a new feature, please wrap it in a feature flag.

  4. Make sure to check out the JavaScript Style Guide and ensure that your code complies with the rules. If you missed a rule or two, don't worry, our tests will warn you.

  5. Make the test pass.

  6. Commit your changes. Please use an appropriate commit prefix. If your pull request fixes an issue specify it in the commit message. Some examples:

[DOC beta] Update CONTRIBUTING.md for commit prefixes
[FEATURE query-params-new] Message
[BUGFIX beta] Message
[SECURITY CVE-111-1111] Message

For more information about commit prefixes see the appendix.

  1. Push to your fork and submit a pull request. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.

We try to be quick about responding to tickets but sometimes we get a bit backlogged. If the response is slow, try to find someone on IRC (#emberjs) to give the ticket a review.

Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:

  • Use Ember idioms and helpers
  • Include tests that fail without your code, and pass with it
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution

Syntax:

  • Two spaces, no tabs.
  • No trailing whitespace. Blank lines should not have any space.
  • a = b and not a=b.
  • Follow the conventions you see used in the source already.

Inline Documentation Guidelines:

All inline documentation is written using YUIDoc. Follow these rules when updating or writing new documentation:

  1. All code blocks must be fenced
  2. All code blocks must have a language declared
  3. All code blocks must be valid code for syntax highlighting
  4. All examples in code blocks must be aligned
  5. Use two spaces between the code and the example: foo(); // result
  6. All references to code words must be enclosed in backticks
  7. Prefer a single space between sentences
  8. Reference Ember.js as Ember.
  9. Wrap long markdown blocks > 80 characters
  10. Don't include blank lines after @param definitions

Code words are:

  • thisPropertyName
  • Global.Class.attribute
  • thisFunction()
  • Global.CONSTANT_NAME
  • true, false, null, undefined (when referring to programming values)
  • references to other properties/methods

And in case we didn't emphasize it enough: we love tests!

NOTE: Partially copied from https://raw.github.com/thoughtbot/factory_girl_rails/master/CONTRIBUTING.md

Appendix

Commit Tagging

All commits should be tagged. Tags are denoted by square brackets ([]) and come at the start of the commit message.

Bug Fixes

In general bug fixes are pulled into the beta branch. As such, the prefix is: [BUGFIX beta]. If a bug fix is a serious regression that requires a new patch release, [BUGFIX release] can be used instead.

For bugs related to canary features, follow the prefixing rules for features.

Features

All additions and fixes for features in canary should be tagged as [FEATURE name] where name is the same as the flag for that feature.

Documentation

Documentation commits are tagged as [DOC channel] where channel is canary, beta, or release. If no release is provided canary is assumed. The channel should be the most stable release that this documentation change applies to.

Security

Security commits will be tagged as [SECURITY cve]. Please do not submit security related PRs without coordinating with the security team. See the Security Policy for more information.

Other

In general almost all commits should fall into one of these categories. In the cases where they don't please submit your PR untagged. An Ember contributor will let you know if tagging is required.