Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.67 KB

Contributing

Thanks for choosing to contribute!

The following are a set of guidelines to follow when contributing to this project.

Code Of Conduct

This project adheres to the Adobe code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Contributor License Agreement

All third-party contributions to this project must be accompanied by a signed contributor license agreement. This gives Adobe permission to redistribute your contributions as part of the project. Sign our CLA. You only need to sign an Adobe CLA once.

Code Reviews

All submissions should come in the form of pull requests and need to be reviewed by project committers. Read GitHub's pull request documentation for more information on sending pull requests.

Lastly, please follow the pull request template when submitting a pull request!

Submitting Issues and PRs

In order to simplify our release workflow, we use conventional-changelog using the eslint preset. As such, your PRs should follow this form:

  • Supply a prefix indicating the type of change -- one of the following:
    • Fix: if the change fixes a bug
    • Update: if the change updates a feature (but doesn't break it)
    • Breaking: if the change is a breaking change
    • New: if the change implements a new feature
    • There are other prefixes you can use; refer to the above preset for more.
  • After the prefix, supply a short but descriptive message.
  • If there is a related issue number, you can specify it at the end of the message inside parentheses, like so:
    • (fixes #215): for bug fixes
    • (refs #215): doesn't fix the issue (perhaps part of a larger fix)

Some good examples:

Breaking: `ObservableArray` methods that used to return arrays will now return wrapped arrays. (refs #109)
New: Added support for the `<elseif>` tag
Update: Improved the performance of `ObservableArray#map` (refs #219)
Fix: Update filenames to avoid case warnings in Webpack (fixes #232)

Template Credits

Inspired by examples at https://github.com/devspace/awesome-github-templates, including: