Help_Pages/Issue_Tracker.Rmd at main · SpeedGoat/Help_Pages · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
---
title: ""
author: ""
output:
  html_document:
    toc: true
    toc_depth: 3
    toc_float:
      collapsed: true
      smooth_scroll: true
    theme: flatly
---
<center>
  <img src = "./www/SG_Horizontal_Transparent_RGB.png">
</center>

# Issue Tracking & Feature Requests

PopR is linked to [GitHub](https://github.com/) issue tracking.  If you have a problem with your software or think of a new feature that would make your life easier the process of telling us about it is simple.  While it might be easier to call or write an email we need a *to do* list in order to provide the service our collaborators deserve.  This list of issues and features lets us assign tasks internally and generally manage projects effectively.  If you choose to email or call we will create an issue anyway, but you won't necessarily see our progress on the topic or conversations unless you go to the site and subscribe to or follow the issue.  We highly encourage our users to try the Issue tracker.  Those who have embraced these tools have found them very useful and provided glowing feedback.  In addition, the public repositories that we maintain for each project also have a wiki that houses presentations and other supplementary materials.

### GitHub

We use [GitHub](https://github.com/) to keep track of versions of our code, back up the code base and facilitate communication.  In order to use the tools provided by this amazing website each user needs to create an account.  Accounts are free and relatively painless to create.  To begin navigate to [GitHub](https://github.com/) and *click* on the Sign up button at the top-right of your screen.  Instructions for creating an account can be found [here](http://www.wikihow.com/Create-an-Account-on-GitHub).  If you prefer short videos (0:56 seconds) you might find this [link](https://www.youtube.com/watch?v=ezxRcdJ8glM) helpful.

***

### Issue Tracking

The official documentation for the issue tracker can be found [here](https://guides.github.com/features/issues/).  Many of the features described in that documentation are not really necessary for our collaborators, but it might be advantageous to become a power user.  For those wanting the official quick overview of the issue tracker the video below might be helpful.

<iframe width="400" height="200" src="https://www.youtube.com/embed/TJlYiMp8FuY" frameborder="0" allowfullscreen>
</iframe>

***

<div style = "color:crimson">
## What you need to know

1. _To begin navigate to the issue tab related to your project_
    + This page shows you all of the current issues and feature requests for your PopR website.  There are also closed issues that you can view by clicking on the word Closed.  Issues are organized by date to help you find what you are looking for.  If you can't find what you want you might try searching using the Filters or checking the Closed issues.  You can also subset the issues by choosing an Author or Labels.

#### Looking for your issue page?
- [Arizona](https://github.com/Huh/PopR_AZGF/issues)
- [CWD Monitoring](https://github.com/Huh/PopR_CWD/issues)
- [Idaho](https://github.com/Huh/PopR_IDFG/issues)
- [Jasper National Park/Alberta](https://github.com/Huh/PopR_Jasper/issues)
- [Montana](https://github.com/Huh/PopR_MT/issues)
- [South Dakota](https://github.com/Huh/PopR_SDGFP/issues)
- [WAFWA/Sage Grouse](https://github.com/Huh/PopR_Sage/issues)
- [Wyoming](https://github.com/Huh/PopR_WGFD)

<br>

<img src = "./www/Issue_img_issue_tab.png">

***

<br>

2. _Click on the new Issue Button_
    + When you click on the new Issue Button you will see a place to describe your issue.

<img src = "./www/Issue_img_new_issue.png">

***

<br>

3. _Describe your issue or idea_
    + The best practice when describing your problem or idea is to use specific details.  An issue that simple says "website crashed" is not useful because we have no way of knowing what you were doing and so cannot reproduce the problem.  If we can reproduce the problem we can fix it.  If all user inputs and the issue are described there is a good chance that we can find the problem.  Similarly, when describing a new feature please fully describe your vision, the problem it solves and why it is important so that it can be implemented as you imagine.

<img src = "./www/Issue_img_eg_issue.png">

<br>

***

<br>

4. _Click Submit new issue_
    + Upon clicking the Submit button the whole Speedgoat team will be notified.  We will respond as soon as possible to let you know we are aware of the issue.

<img src = "./www/Issue_img_issue_submit.png">
</div>

***

<br>

### What now?

Once you have submitted an issue you will be following that issue via email.  Following or watching an issue means that you will receive an email each time something is posted about the issue.  For example, you might receive a question asking for clarification or an explanation as to why the issue occurred.  It is also likely that you will see the issue has been given labels and assigned to someone at SpeedGoat to fix or implement.  If you would like to reply to a follow up question you can do so right from your email or you can view the issue on GitHub by following the link in the email.

***

Developed by Josh Nowak, [SpeedGoat](https://www.speedgoat.io)

<img src = "./www/SG_Horizontal_Transparent_RGB.png" height = "122" width = "162">

<br>

***

<br>

<div style="padding-bottom:100px"></div>