Last updated August 31, 2012. Created by mitchell on May 24, 2012.
Edited by mbouchard58. Log in to edit this page.

These guidelines are to help you get the most benefit when you submit a Rules issue.

Content

  • Clarity is king!!
  • If you need to spend more time ensuring maximum readability, it will be appreciated by all potential reviewers. If you aren't proficient with English, then you may post in your most familiar language first, and we can translate it later.
  • Make sure to search for ongoing issues and old ones to help the Rules maintainers not have to mark it as a duplicate. You'll learn a lot this way and be able to go directly to the most relevant topic rather than creating a new one.
  • Double check to make sure your issue really belongs in the Rules issue. Integrations provided within Rules are the only ones that belong in this issue queue. If another module is involved, then there may already be an issue in that module's issue queue, tagged 'rules integration'.

Formatting

  • [#12345], read "[#", then a drupal.org node id, then "]"), is a dynamic link that changes colors and name based on the status and title of the referenced issue. This is more useful than pasting a url.
  • Issue summaries (the first post) can be updated. When an issue is tagged "needs issue summary", then it is encouraged for other users to help in the process.
  • Use the "< code >" tag to make development code, exports, and error messages more readable.
  • If you want to paste more than 10 lines, upload it as a txt file instead. It will be included beneath your comment.
  • When an issue is inactive it will be marked as postponed.
  • When an issue lacks the necessary information for contributors to get involved, it will be marked as postponed (maintainers need more info).

Workflow

  • Reopening old issues is reserved for a limited set of circumstances. This is important! Once an issue has reached a resolution, consider anything added after that point out of place by default. All it takes to continue a discussion is clicking 'create an issue' and then put a [#12345]-like dynamic link to establish a relationship. Often times work continues from one issue into other issues.
  • Continuing to post in an issue that has been marked fixed or closed is discouraged in nearly all circumstances, because once a maintainer sees it is fixed, everything up to that point has reached a significant milestone. It is taken off a mental list of a lot of things, which is a good feeling. So it can be very annoying to have to address someone change it selfishly or unintentionally. This can also be blamed on a bug in the tools as well. [#??]only allow project issue maintainers to reopen issues.
  • Priority of issues is measured by communal benefit. Any user can set the priority to whatever they think it is, however a more long-term beneficial measure is what people think or would think as a group. Anyone can voice their opinion, it is not required, however it can be beneficial to add.

Support Requests

  • Focus on what you want to accomplish as opposed to the background information. Many times, the particular question is difficult to identify because it is infused in a larger set of descriptions.
  • You are currently reading a page in the Rules Documentation Handbook. The sidebar on the right contains navigation to other sections that very likely have the information you need. Check first before submitting your issue.
  • If you find an answer to your question before someone answers it, or if you receive assistance in #drupal-support, then update your issue ASAP and mark your issue as fixed. This is a big help to other users and especially to the maintainers.

Patch Guidelines

  • How to patch
  • How to checkout from git

Feature Requests

Bug Reports

  • Make sure you are using the latest releases of Rules, Entity API, and any other relevant modules.
  • Try to verify the problem with the latest development snapshot
  • Include exact steps to reproduce the bug

Looking for support? Visit the Drupal.org forums, or join #drupal-support in IRC.