Skip to content

Developer guidelines

Edward L Platt edited this page Mar 19, 2014 · 7 revisions

TL;DR

  • Talk to the dev-list or join the weekly hangout before implementing a change.
  • Submit changes as pull requests from an issue branch to the dev branch.
  • Spaces and unix line endings.

Contents

Pull requests

  1. To encourage code review, submit all changes as pull requests.
  2. Pull requests should be from an issue-specific branch to the dev branch.
  3. Pull requests should be reviewed and approved by someone other than the author.
  4. Contributors should add themselves to the CONTRIBUTORS file.
  5. All new features must be discussed on the dev list or weekly hangout before they are implemented.
  6. Pull requests should not mix changes to the core system and modules.
  7. Pull requests should not affect more than one module.

Coding standards

  1. We follow Drupal Coding Standards.
  2. We indent with spaces only, no tabs.
  3. We use UNIX line endings.
  4. If you are looking for a good editor that lets you control line endings and whitespace, try Komodo Edit.

Commit messages

  1. Include issue numbers in commit messages.
  2. Include a descriptive summary of 80 characters or less, ending with a period.
  3. More details can go after the summary.
  4. Example: "Add javascript to focus elements with focus class; close #74."