Project path: Feedback Collect

Introduction

The Feedback Collect module allows site builders to add feedback forms to their sites and gather end user feedback, bug reports or any kind of suggestions. It is highly customizable.

Features

  • Collect quick feedback on suggestions/bugs/ideas from users
  • Anonymous feedback in case user doesn't want to provide email or wants his account to be associated with the feedback
  • Configurable and themeable to fit your expectations from this module
  • If user accidentally closes feedback form, ability to retrieve what was written earlier
  • Collects browser info and displays in readable output
  • If there's bootstrap support, it adds bootstrap-related styling and uses bootstrap modal to display feedback form on small res devices (if it's available)
  • Ability to use completely custom CSS so you don't have to override module's styles, write your own to fit your theme
  • Additional fields can be easily added like to the rest of the content types
  • Smooth integration with HTML5 Drag & Drop File module for easier attachment management

Requirements

This module requires the following modules:

The following libraries are recommended in order to make the best of the module:

  • UAParser.js
    Library is used to retrieve and parse browser info when user submits feedback. Helps out with parsing to a human readable output in feedback listing.

Recommended Modules

  • HTML5 Drag & Drop File
    When enabled, attachments can be added to feedback by dragging file and dropping it to the form, which makes it more user friendly.

Similar Modules

  1. Feedback
    Lightweight module for collecting user feedback. It has fewer dependencies than "Feedback Collect", but also fewer configuration options.
  2. Feedback Reloaded
    This module has the option for sending screenshot of the page from which the feedback is submitted and option for highlighting/blackouting the page content. Requires Java installed on client side.
  3. Livefeedback
    Very good module for collecting feedbacks. Like "Feedback Reloaded", it has the option for sending screenshot of the current page with highlights and blackouts. All feedbacks can be exported to csv. Lacks configurable options and theme support.

Installation

Install as you would normally install a contributed Drupal module.
See: https://drupal.org/documentation/install/modules-themes/modules-7 for further information.

Download and install ua-parser library. See: https://www.drupal.org/node/1440066 for further information.

It is important that your file structure looks like:

- sites/all/libraries/ua_parser/src/ua-parser.js or profiles/your_profile/libraries/ua_parser/src/ua-parser.js

Configuration

  • Configure user permissions in Administration » People » Permissions
    1. Feedback: Create new content (Node module)
      If this permission is granted, users will be able to submit feedback.
    2. View submitted feedback
      Access feedback content.
  • Customize the settings in Administration » Configuration and modules »
    User interface » Feedback Collect.
  • You may add the menu link to the feedback listing page in Administration » Structure » Menus. Menu link path is 'feedback-collect'.

Troubleshooting

  • If the "Collect Feedback" button does not display, check the following:
    1. Check the button position in Administration » Configuration and modules » User interface » Feedback Collect. If "Use custom CSS" checkbox is checked, analyze your CSS to find where the button might be located. Make sure you add fixed positioning to .feedbackCollect-container class and define x and y axis (either top/bottom and left/right property) to make sure it functions properly.
    2. Check the "Exclude paths" setting in Administration » Configuration and modules » User interface » Feedback Collect.
    3. Is the "Feedback: Create new content" permission enabled for the appropriate roles?
  • If the menu link does not display, check the following:
    1. Is the "View submitted feedback" permission enabled for the appropriate roles?

Git Clone Command

git clone --branch 7.x-1.x http://git.drupal.org/sandbox/ntucakovic/2490642.git feedback_collect
cd feedback_collect

Maintainers

Current maintainers:

This project has been sponsored by: Byteout Software

Manual reviews of other projects
[D7] Block by date - https://www.drupal.org/node/2427175#comment-10056818
[D7] Block Background - https://www.drupal.org/node/2511228#comment-10066560
[D7] GPX Track & Elevation - https://www.drupal.org/node/2474101#comment-10066562

Comments

ntucakovic’s picture

ntucakovic commented
Issue summary: View changes
PA robot’s picture

PA robot commented
Status: Needs review » Needs work

Git clone command for the sandbox is missing in the issue summary, please add it.

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

ntucakovic’s picture

ntucakovic commented
Issue summary: View changes

Added git clone command

ntucakovic’s picture

ntucakovic commented
Issue summary: View changes
Status: Needs work » Needs review

Changed status to needs review, Git clone command added

PA robot’s picture

PA robot commented
Status: Needs review » Needs work

There are some errors reported by automated review tools, did you already check them? See http://pareview.sh/pareview/httpgitdrupalorgsandboxntucakovic2490642git

I'm a robot and this is an automated message from Project Applications Scraper.

ntucakovic’s picture

ntucakovic commented
Status: Needs work » Needs review

Updated coding standard and fixed some errors

darol100’s picture

darol100 commented
Status: Needs review » Needs work
Issue tags: +PAreview: security

@ntucakovic,

What is the different between the modules that you provide that are similar ? The git clone that you provide on your was only for the maintainers.

  • README.txt I would recommend you to remove this from your README.TXT.
    FEEDBACK COLLECT
----------------


CONTENTS OF THIS FILE
---------------------
   
 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Troubleshooting
 * Maintainers

    just because that's not how we writes README.txt files.

  • You should provide the hook_help to allow site builders to find information about your module.
  • Coder should some errors:
    feedback_collect.install

Line 16: Potential problem: drupal_set_message() only accepts filtered text, be sure all !placeholders for $variables in t() are fully sanitized using check_plain(), filter_xss() or similar. (Drupal Docs)

  drupal_set_message($t('Module settings are available under !link',

    that is a security problem so this issue is a blocker.

klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Status: Needs work » Needs review
Issue tags: -PAreview: security

@darol100: the problem Coder reports is a false positive, since no user provided text is involved here at all. Make sure to read https://www.drupal.org/node/28984 again which explains XSS and when to use filtering functions. Please verify security issues before setting applications to "needs work".

So as you can see the old Coder Review reports many false positives, that's why we don't run it on pareview.sh and use the more precise Coder sniffer instead.

ntucakovic’s picture

ntucakovic commented
Issue summary: View changes

Updated git clone command, my bad.

@darol100 I have described below module that's mentioned what is different about it.

Regarding readme.txt files, we've been working on readme.txt based on this url: https://www.drupal.org/node/2181737, so seems like it should be fine?

And I'm just working on hook_help, thanks for that.

EDIT: Implemented hook_help

ntucakovic’s picture

ntucakovic commented

Noticed a cross-browser bug with js. I don't think that it's a blocker bug, so I'll address it while we're waiting to get reviewed for the module.

EDIT: Fixed

intnick’s picture

intnick commented
Status: Needs review » Reviewed & tested by the community

Tested the module on the company intranet, worked with no issues cross browser (Chrome, FF)

ntucakovic’s picture

ntucakovic commented

3 weeks have passed since last review, what should I do on my end to be able to promote this to full project?

ntucakovic’s picture

ntucakovic commented
Issue summary: View changes
Issue tags: +PAreview: review bonus
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Assigned: Unassigned » avpaderno
Status: Reviewed & tested by the community » Fixed

Thanks for your contribution!

I updated your account so you can promote new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thank you to the dedicated reviewer(s) as well.

ntucakovic’s picture

ntucakovic commented

Thank you! There will be more contributions of course! :)

ntucakovic’s picture

ntucakovic commented
Issue summary: View changes
ntucakovic’s picture

ntucakovic commented
Issue summary: View changes

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.