Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 2.47 KB
Raw

Contributing

First of all, thank you for considering contributing to the Shoreditch theme!

Things to know before you start

  1. Bear in mind that the theme is currently in an alpha stage and at such many (even fundamental) things can be subject to change!
  2. Please read the README to get an overview of what the theme is and how it works.
  3. The org.civicrm.styleguide extension is a very useful companion to the theme, please make sure to have it installed and enabled locally when working on Shoreditch.

Reporting a bug / Suggesting enhancements

Both bugs and enhancements suggestions are tracked as GitHub issues.

If you want to report a bug, please make sure to provide:

  • Shoreditch, CiviCRM, and Drupal versions
  • Steps to reproduce
  • Screenshots (if the bug relates to styling issues)

If you want to suggest an enhancement, please make sure to provide:

  • A clear description of the suggested enhancement
  • Reason why it would be beneficial for the theme

Code contributions

If you'd like to contribute to the project, please make sure to familiarize with the coding documentation and with how to appropriately test your style changes before submitting your contribution!

Git commit messages guidelines

  • Use the present tense ("Customize .panel-primary" not "Customized .panel-primary")
  • Use the imperative mood ("Add padding to .panel" not "Adds padding to .panel")
  • First line should have a length of max 72 characters
  • Reference any issues or pull requests that you think is useful to mention

Submitting a PR

When your work is complete and you have tested it locally, you can open a PR against the master branch.

In the PR give a description of what you changed (and why!), and attach before & after screenshots to show the effects of your changes.

Please be aware that the min files (bootstrap.css, custom-civicrm.css) must not be included in any of your commits, as any PR should include source files (.scss) only.

Currently you are also required, for any work done on the style, to attach a screenshot of the BackstopJS report (see here), showing how many tests passed, how many failed and which ones.

The PR will then undergo code review and, once the changes are accepted, it will be merged and become part of the theme's next release!