Overview

Yii SCM Issues Module

What is it?

This module allows you to set up a page in a restricted area of your web site. On this page users can communicate with you through issues, which are hosted on a GitHub/Bitbucket/(implement your own SCM provider wrapper) repo, associated with your website. It's a more convenient way to handle all feedback in on place.

What it's not?

It's not a feedback form. It's not a complete replace for a GitHub/Bitbucket web UI.

Setup

  • Extract modules' contents into /protected/modules directory
  • In config.php add

    'modules' => array(
        // ... some code here ...
        'issues' => array(
            'provider' => 'github', // see models/ScmProvider.php file for custom providers
            'username' => 'your_scm_username',
            'password' => 'your_scm_password',
            'repoSlug' => 'your_scm_repo_slug', //basically a part of your repo's URL which represents repo's name in a URL-friendly format
        ),
        // ... some code here ...
    ),
    
  • Proceed to http://your-yii-app/issues

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.