Tutorial

Let's get you up to speed.

Log In

Click the Login link to connect your GitHub account with Git Reports. You'll be redirected to log in to GitHub, and then asked if you want to grant the application access to your repositories. Click "Accept" and you'll be redirected back to the site.

Profile

After logging in, you'll be redirected to your Profile page. Here, you'll see a list of repositories that you own. You'll also see separate tables for any organizations with repositories for which you are a member (only pull access is required). To see a summary of the repository's information, click its name in the list. To edit its settings, click the "Edit" link next to the repository's name. Repositories are always inactive by default; to allow anonymous users to post issues to a repository, activate it by clicking the "Activate" link next to its name. (The "Activate" link turns into a "Deactivate" link if the repository is already activated, and behaves as you would expect.) Finally, click the "View" link next to a repository to view its public page if it has been activated- this is where you should direct anonymous users to submit issues/bugs.

Repository Settings

Git Reports maintains a few settings for each repository to allow you to customize anonymous user experience and configuration for when the application creates new issues on GitHub.

Prefilling Fields

If you'd like, you can prefill the fields in an active repository's issue page by passing appropriate values as URL parameters. The parameters name, email, and details (e.g. https://gitreports.com/issue/schneidmaster/gitreports.com/?name=The%20Issue) will fill in the respective field with the passed value. Remember to appropriately URL-encode special characters.