Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 3.12 KB
Raw

Contributing to Acquia Recommended Project

Acquia Recommended Project feature requests, bugs, support requests, and milestones are tracked via the GitHub issue queue.

Before submitting an issue or pull request, please read and take the time to understand this guide. Issues not adhering to these guidelines may be closed.

Submitting issues

Please choose your issue type carefully. If you aren't sure, odds are you have a support request.

  • Feature request: a request for a specific enhancement to be made to the package. This is distinct from a bug in that it represents a gap in functionality, rather than an instance of the plugin behaving badly. It is distinct from a support request in that it has a specific and atomic request for new functionality, rather than being a general request for help or guidance.
  • Bug report: a clearly defined instance of package not behaving as expected. It is distinct from a feature request in that it represents a mismatch between what does and what claims to do. It is distinct from a support request in that it has specific steps to reproduce the problem (ideally starting from a fresh installation) and justification as to why this is a problem rather than an underlying tool such as Composer or Drush.
  • Support request: a request for help or guidance. Use this if you aren't sure how to do something or can't find a solution to a problem that may or may not be a bug. Before filing a support request, please review the FAQ for solutions to common problems and general troubleshooting techniques. If you have an Acquia subscription, consider filing a Support ticket instead of an issue in order to receive support subject to your SLA.

After you have chosen your issue type, make sure to fill out the issue template completely.

Note the following when submitting issues:

  • Issues filed directly to the project are not subject to an SLA.
  • This project is distributed under the GPLv2 license; all documentation, code, and guidance is provided without warranty.
  • The project maintainers are under no obligation to respond to support requests, feature requests, or pull requests.

Submitting pull requests

Please note the branch statuses documented in the README:

  • Pull requests for enhancements will only be accepted for the active development branch.
  • Pull requests for bug fixes will only be accepted for supported branches.
  • When submitting a pull request for a bug fix or enhancement that may apply to multiple branches, please submit only a single PR to the latest development branch for review. A maintainer will backport the fix if appropriate.

Pull requests must also adhere to the following guidelines:

  • PRs should be atomic and targeted at a single issue rather than broad-scope.
  • PRs must contain clear testing steps and justification, as well as all other information required by the pull request template.
  • PRs must pass automated tests before they will be reviewed. We recommend you run the tests locally before submitting (see below).
  • PRs must comply with Drupal coding standards and best practices as defined by the project maintainers.