Skip to content

Commit

Permalink
Added issues and comments screens (beta) (#31)
Browse files Browse the repository at this point in the history
* Enhanced issue and comments screens on example

* Added report screens

* Added required packages

* Added required extensions

* Imrpoved include screenshots implementation

* Added openReportScreen method

* Added required packages

* Added screens and widgets

* update example

* Added upcoming features & tips

* minor updates

* minor update readme

* Updated changelog

* Handled large screen

* minor update

* get only issue releated with user (bug from last version)

* bump version
  • Loading branch information
M97Chahboun authored Dec 14, 2023
1 parent f793fa9 commit d2b2d59
Show file tree
Hide file tree
Showing 14 changed files with 543 additions and 351 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,10 @@
* Added report issue on app version milestone

## 0.0.13
* Update dependencies
* Update dependencies

## 0.0.14
* Added `GhSnitch.openReportScreen(context);` for open report screen with follow options
- Report issue with screenshot
- Submit comment to issue
- Follow up issue status
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ GitHub Snitch is a Flutter package that helps you report bugs and issues on GitH
- GhSnitch-internal for Errors caught by Flutter Framework
- Reported by GhSnitch Package for knowing which issues are reported from this package

## Upcoming features
- Support notifications for chat with user and repository owners

## Tips
> [!TIP]
> Is preferable to use empty repo for reporting issues & bugs then transfer important items to main repo
> [!TIP]
> For send screenshot to user from issue comment use some website for upload image and add link to comment, don't use screenshot from github repo because it will not work
> [!TIP]
> For send screenshot to user from issue comment use some website for upload image and add link to comment, don't use screenshot from github repo because it will not work
> [!TIP]
> You can use ready screens by call `GhSnitch.openReportScreen(context);` or build ypu screens and use methods like `GhSnitch.report` & `GhSnitch.submitComment` to submit issues & comments
> [!TIP]
> Create branch for upload screenshots with name `screenshots` or any name you want but you need to pass this name to `screenShotBranch` parameter in `GhSnitch.report` method if you used `GhSnitch.openReportScreen(context);` you should use `screenshots` name
## Getting Started

Expand Down
8 changes: 2 additions & 6 deletions example/lib/main.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import 'package:example/reports.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:github_snitch/github_snitch.dart';
Expand Down Expand Up @@ -26,6 +25,7 @@ class MyApp extends StatelessWidget {
Widget build(BuildContext context) {
return MaterialApp(
title: 'Report Issues on your repo',
debugShowCheckedModeBanner: false,
theme: ThemeData(
// This is the theme of your application.
//
Expand Down Expand Up @@ -94,11 +94,7 @@ class _MyHomePageState extends State<MyHomePage> {
actions: [
IconButton(
onPressed: () {
Navigator.of(context).push(MaterialPageRoute(
builder: (context) {
return Reports();
},
));
GhSnitch.openReportScreen(context);
},
icon: const Icon(Icons.report))
],
Expand Down
331 changes: 0 additions & 331 deletions example/lib/reports.dart

This file was deleted.

Loading

0 comments on commit d2b2d59

Please sign in to comment.