-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathsetup.html
179 lines (164 loc) · 8.92 KB
/
setup.html
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Landing page">
<title>Propr</title>
<style>
/*
Consider adding styles to the css folder
All existing styles havebeen moved to a separate CSS file for clarity
*/
body {
background: url(img/cream_dust.png) repeat 0 0;
}
</style>
<!-- Pure CSS -->
<link rel="stylesheet" href="https://unpkg.com/[email protected]/build/pure-min.css" integrity="sha384-" crossorigin="anonymous">
<!-- Favicon -->
<link rel="shortcut icon" type="image/x-icon" href="img/favicon.png" />
<!--[if lte IE 8]>
<link rel="stylesheet" href="https://unpkg.com/[email protected]/build/grids-responsive-old-ie-min.css">
<![endif]-->
<!--[if gt IE 8]><!-->
<link rel="stylesheet" href="https://unpkg.com/[email protected]/build/grids-responsive-min.css">
<!--<![endif]-->
<!--[if lte IE 8]>
<link rel="stylesheet" href="css/layouts/landing-old-ie.css">
<![endif]-->
<!--[if gt IE 8]><!-->
<link rel="stylesheet" href="css/layouts/landing.css">
<!--<![endif]-->
</head>
<body>
<div id="layout" class="pure-g">
<div class="sidebar pure-u-1 pure-u-md-1-4">
<br style="line-height: 400%;">
<img class="pure-img" style="max-width: 80%; display: block; margin: 0 auto;" src="img/propr_logo.png">
<div class="header">
<h1 class="brand-title">Assess reviewability</h1>
<h2 class="brand-tagline">Enable propr for your repo</h2>
<nav class="nav">
<ul class="nav-list">
<li class="nav-item">
<a class="pure-button" href="https://github.com/apps/propr">Login with Github</a>
</li>
</ul>
</nav>
</div>
</div>
<div class="content pure-u-1 pure-u-md-3-4">
<div class="posts">
<section class="post">
<header class="post-header">
<h2 class="post-title">Introduction</h2>
</header>
<div class="post-description">
This is a plugin that collects feedback on the reviewability of pull requests from the reviewers. Whenever a pull request merged or closed in a repository for which you have enabled this app, our bot posts a link to a feedback form in the pull request discussion page. We use the collected data to gain insights on what makes pull requests reviewable and help developers create more reviewable patches. If you have already installed our plugin, check out <a href="http://propr.tudelft.nl/report.html">your report</a> to see how well you and your pull requests are doing.
</div>
</section>
</div>
<br>
<div>
<!-- A wrapper for all the posts -->
<div class="posts">
<h1 class="content-subhead">Initial Setup Instructions</h1>
<section class="post">
<header class="post-header">
<h2 class="post-title">Recommended method: Authorize our app through Github</h2>
</header>
<div class="post-description">
<ul>
<li>Authorize our app by logging into Github <a href="https://github.com/apps/propr">here</a></li>
<li>Select your repos for which you'd like to enable PR Feedback when prompted</a></li>
<li>Don't forget to fill in your feedback on the link posted by our bot whenever you close a PR</a></li>
</ul>
</div>
</section>
<section class="post">
<header class="post-header">
<h2 class="post-title">Alternative setup: Add a webhook that connects to our servlet</h2>
</header>
<div class="post-description">
<ul>
<li><h3>For private repositories:</h3>
<ul>
<li>To add a collaborator go to Settings, then Webhooks from your repository</li>
<li>Add <i>prfeedback</i> as a collaborator by using the user search box at the bottom of the page.</li>
<li>Continue setting up the webhook as described for public repositories in the next section</a></li>
</ul>
</li>
</ul>
<ul>
<li><h3>For public repositories:</h3>
<ul>
<li>Add a webhook by going to Settings, then Webhooks from your repository</li>
<li>Set the payload URL to the address <i>http://chennai.ewi.tudelft.nl:60002/webhook</i></li>
<li>Set the content type to <i>application/json</i></li>
<li>Ensure that the only data that is being sent over is that related to Pull Requests. To see more about how to setup webhooks, see <a href="https://developer.github.com/webhooks/creating/">this page</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<br>
<div class="posts">
<h1 class="content-subhead">How it works</h1>
<br>
<section class="post">
<div class="pure-g">
<div class="pure-u-1 pure-u-md-1-2 pure-u-lg-1-2">
<div class="l-box">
<header class="post-header">
<h3>Click on the feedback link</h3>
</header>
<br>
<div class="post-description" style="margin-right: 1em">
When one of the project maintainers close a pull request, our bot comments on the pull request with a feedback link. Please note that you might have to refresh the page to see this link.
</div>
</div>
</div>
<div class="pure-u-1 pure-u-md-1-2 pure-u-lg-1-2">
<div class="l-box">
<header class="post-header">
<h3>Fill out the feedback form</h3>
</header>
<br>
<div class="post-description">
The short feedback survey has two open ended questions and three rating bars, all of which are optional. But we would appreciate it if you answered all of them. After all, more data leads to better personal reports.
</div>
</div>
</div>
<div class="pure-u-1">
<br>
<img class="pure-img rcorners" src="img/form.png">
<br>
</div>
<div class="pure-u-1">
<div class="l-box">
<header class="post-header">
<h3>Check out your personal report</h3>
</header>
<br>
<div class="post-description">
If you have contributed to a repository, or if you have installed our app for one of your repositories, you can check out the comprehensive report we have generated for you based on the feedback provided by the maintainers on the pull requests. If you are the owner of the repository you can view the feedback on all the pull requests submitted by all contributors. To see your report, just head over to <a href="http://propr.tudelft.nl/report.html">this page.</a>
</div>
</div>
</div>
<div class="pure-u-1">
<br>
<img class="pure-img rcorners" src="img/report.png">
<br>
</div>
</div>
</section>
<p style="font-size: 100%; color: #aaa;"><b>Privacy statement:</b> We don't store any personal information such as your email address or name.
We ask for GitHub authentication as an anonymous identifier to account for duplicate feedback entries and to see people specific preferences.</p>
</div>
</div>
</div>
</body>
</html>