diff options
author | William Carroll <wpcarro@gmail.com> | 2020-04-10T12·35+0100 |
---|---|---|
committer | William Carroll <wpcarro@gmail.com> | 2020-04-10T12·40+0100 |
commit | a2f68732de7003ed52c9e5b77ba6fd09104dd546 (patch) | |
tree | 22bb8eafc18fe2a8ec6665fcaed231e1dee2b7bf /website/sandbox/github-issues-service | |
parent | ca67b4256dc79fd5da9fbfe8ead302fbfdc5abdf (diff) |
Create README for Github Issues Service
See the README for an overview of the concept. Basically I would like a simpler way to collect feature requests and bug reportss from my web apps.
Diffstat (limited to 'website/sandbox/github-issues-service')
-rw-r--r-- | website/sandbox/github-issues-service/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/website/sandbox/github-issues-service/README.md b/website/sandbox/github-issues-service/README.md new file mode 100644 index 000000000000..2af860014378 --- /dev/null +++ b/website/sandbox/github-issues-service/README.md @@ -0,0 +1,28 @@ +# Github Issues Service (GIS) + +> 'Cause I got issues. But you got 'em too... +> - [Issues by Julia Michaels][issues] + +You have a website and your users want to request features or report bugs. How +do they do this? + +Our robot, GIS, can help you. GIS adds a widget to your website that allows +users to easily request features and report bugs. + +## Getting Started + +If Github is hosting your website's source code, you're ready to start using +GIS. GIS works with public and private repositories. + +Let's adopt Github's notion of "issues" to group feature requests and bug +reports together. When users click the GIS widget to create an issue, GIS +displays a modal form that the user completes. When the user submits the form, +GIS creates an issue on your Github repository. Now your team can use all of +Github's rich issue-tracking tools to manage your issues. + +## Installation + +To add GIS to your website, register your Github repository with us and we'll +give you a snippet to add to your website's HTML. It's that simple. + +[issues]: https://www.youtube.com/watch?v=9Ke4480MicU |