Interact directly with repository

[jarrah42]

As a developer I want to use RYP to maintain the current status of my project practices so that I can track progress towards improving the practices

Parent	Children	Related	Blocks	Depends On
	#93, #95

Acceptance Criteria:

Description, Additional Detail, Context:

I would like to be able specify my own survey questions (and grouping of the questions) in a file that I store in my repository. I would like the answers to the survey questions to also be stored in the repository so that RYP and other tools can access the information.

Implemented By Task(s):

• Task: <task url or ID>

[jarrah42]

Here is a diagram of what I am thinking of: ryp.pdf

[elaineraybourn]

I have some questions about Vaadin, see https://phauer.com/2015/evaluating-vaadin-strengths-weaknesses/. @jarrah42 and I have discussed this briefly.

[jarrah42]

Here is my idea for the initial flow starting at the home page. Mockups of the initial pages are also provided.

• ryp_mockup.pdf
• ryp_flow.pdf

UI changes:

• The home screen dispenses with the left nav bar (note changed text). Clicking on button goes to unauthenticated flow.
• Clicking "sign in" opens dialog shown in slide 2. Initially only GITHUB will be available (other types will be added as separate modules - not twitter)
• After authenticating, user taken to slide 3 and Assessment tab is shown. Note changed layout and new button. Add "help" item on left nav also.

Flow:

• Unauthenticated flow unchanged
• Once authenticated, user should be able to select a repository (from a dialog perhaps?) or enter a URL
• Repo is checked to see if a custom survey exists. If not, the default survey is used. If so, the custom survey is loaded.
• If survey exists, repo is checked for status (from previous survey). If so, status is loaded.
• Survey is now completed
• User now has the option to save the completed survey and status in repo

[elaineraybourn]

@jarrah42 would the file from FYP be in the format of a Progress Tracking Card as available in the catalog?

[jarrah42]

What is FYP? Which file are you referring to?

[elaineraybourn]

@jarrah42 Oops that was a typo. I meant RYP. My question is, will the survey results file from RYP be formatted as a PTC -- target, goal, user story, scores, etc.?

[jarrah42]

No, the survey results will be just that - the answers to the questions specified in the survey. I would expect we will use a json format that also captures the date the survey was completed and the different users who completed it.

I see the PTC module using the results of the survey (e.g. by displaying the spider chart) to allow the user to focus on one (or more) of the categories/questions. From this, we can pull a sample PTC from our catalog and show it to the user, perhaps allowing them to modify it. Once they do this, the can choose to add it as an issue directly to the repo (since they will already have authenticated with GitHub) with the appropriate tags, etc.

[elaineraybourn]

I see. "The PTC module using the results of the survey" is the part of PSIP automation that remains underexplored by our team so I am looking forward to making this happen.

[jarrah42]

The tracking module can then do the following:

• display the survey results over time showing how it has changed
• pulling all the PTC issues from the repo and displaying their status