-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathindex.html
177 lines (174 loc) · 10.6 KB
/
index.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
<!DOCTYPE html>
<html>
<head>
<title>Forkability</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="canonical" href="https://basicallydan.github.io/forkability" />
<link rel="stylesheet" type="text/css" href="pages/bootstrap/css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="pages/bootstrap/css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="pages/font-awesome/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="pages/bootstrap-social/bootstrap-social.css">
<link rel="stylesheet" type="text/css" href="pages/pages.css">
<link rel="shortcut icon" type="image/x-icon" href="pages/favicon.ico">
<script class="handlebar-template" id="sign-in-template" type="text/x-handlebars-template">
<div class="row">
<div class="hero col-md-12">
<h2 class="summary">A linter for your repository.</h2>
<p class="col-md-6 col-md-offset-3">Forkability helps you to make your project more open-source-friendly by pointing out missing features and useful tips.</p>
{{#if showAlert}}
<div class="alert alert-info alert-dismissible" role="alert" style="clear:both">
<button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
Sorry, to prevent GitHub API request limits being hit you need to sign in to continue.
</div>
{{/if}}
<div class="col-md-6 col-md-offset-3">
<a class="btn btn-social btn-large btn-github sign-in"><i class="fa fa-github"></i> Sign in with GitHub</a>
<p class="skip-for-now">or <a href="#">skip for now</a></p>
</div>
<p class="login-explanation col-md-6 col-md-offset-3">Why sign in? You need to sign in just to prevent GitHub API request limits being hit. The prompt will ask you for <strong>read-only</strong> access to your public GitHub info. <strong>Forkability cannot change your profile at all.</strong></p>
</div>
</div>
</script>
<script class="handlebar-template" id="loading-repo-template" type="text/x-handlebars-template">
<div class="loading">
<h2>{{repoUser}}/<wbr>{{repoName}} is being linted…</h2>
</div>
</script>
<script class="handlebar-template" id="logging-in-template" type="text/x-handlebars-template">
<div class="loading">
<h2>Logging you in</h2>
</div>
</script>
<script class="handlebar-template" id="choose-repo-template" type="text/x-handlebars-template">
<div class="row">
<div class="hero col-md-12">
<h2 class="summary">A linter for your repository.</h2>
<p>Forkability helps you to make your project more open-source-friendly by pointing out missing features and useful tips.</p>
<h3 style="display:block">Enter the username of the repo owner and the repo to lint.</h3>
</div>
</div>
<div class="row">
<div class="col-md-offset-4 col-md-4">
<form class="repo-form">
<div class="form-group">
<label for="username">Repository owner</label>
{{#if defaultUsername}}
<input type="text" id="username" placeholder="Default: {{defaultUsername}}" class="username form-control left-of-slash">
{{else}}
<input type="text" id="username" class="username form-control left-of-slash">
{{/if}}
</div>
<datalist id="repositories"></datalist>
<div class="form-group">
<label for="repository">Repository name</label>
<input type="text" id="repository" class="repository form-control right-of-slash" list="repositories">
</div>
<datalist id="languages"></datalist>
<div class="form-group">
<label for="language">Language (optional)</label>
<input type="text" multiple placeholder="Default: none" id="language" class="language form-control right-of-slash" list="languages">
</div>
<ul id="selected-languages" class="selected-languages">
</ul>
<button class="btn btn-primary btn-block" id="check-forkability">Check Forkability</button>
</form>
</div>
</div>
</script>
<script class="handlebar-template" id="repo-info-template" type="text/x-handlebars-template">
<h2>{{repoUser}}/<wbr>{{repoName}}</h2>
<span class="go-back"><a href="{{rootPath}}"><i class="fa fa-arrow-circle-left"></i> Try another</a></span>
<div class="row">
<div class="col-md-6 passed-list">
<h2>Features <a href="#" class="explanation-link found-explanation" data-toggle="modal" data-target="#features-modal">(Explanation)</a></h2>
<ul class="results-list passed-features">
</ul>
</div>
<div class="col-md-6 failed-list">
<h2>Suggestions <a href="#" class="explanation-link found-explanation" data-toggle="modal" data-target="#features-modal">(Explanation)</a></h2>
<ul class="results-list failed-features">
</ul>
</div>
</div>
</script>
<div class="modal fade" id="features-modal" tabindex="-1" role="dialog" aria-labelledby="features-modal-label" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="myModalLabel">Features & Suggestions</h4>
</div>
<div class="modal-body">
<p>Forkability recommends a few files, folders and other features for open-source projects, and this project has the ones with ticks by them.</p>
<p>Under "Suggestions" is a list of features which the project doesn't have but could probably benefit from. Some of the more common ones are explained below.</p>
<h5>Contributing Guide</h5>
<p>The contributing guide is a file which explains to any would-be contributors some important things they should know before they open an issue, fork the repo or create pull request. It is often simply called <code>CONTRIBUTING</code> without an extension, but some people prefer to use Markdown (<code>.md</code> or <code>.markdown</code>) or <code>.txt</code>.</p>
<p>Some of the things which should be included in your contributing guide are:</p>
<ul>
<li>The goal of the project. To make sure contributors don't open issues which are way outside of the scope of the project, any pre-determined limitations of the project should be outlined here by explaining what the project intends to achieve.</li>
<li>Coding style guidelines. E.g. variable naming conventions, architectural patterns used, indent characters used.</li>
<li>Test-writing guidelines. E.g. BDD-style, end-to-end, extent of coverage.</li>
</ul>
<h5>Licence</h5>
<p>The licence is a file which explains to any users or would-be contributors how they can reuse your code or project. It is often simply called <code>LICENSE</code> without an extension, but some people prefer to use <code>.txt</code>.</p>
<p>If you are unsure which licence to choose for your project then <a href="http://choosealicense.com/">Choosealicense.com</a> by GitHub attempts to demystify the licence selection process.</p>
<p>If you want to share your work with others, please consider choosing an open source license.</p>
<h5>Untouched & Uncommented Issues</h5>
<p>GitHub's issue tracker is a feature commonly used both by users of open-source code and the code's owners or contributors for keeping track of bugs and new features.</p>
<p>Forkability looks for any <strong>open</strong> issues which weren't created by the repository owner which haven't been commented, and labels these as <strong>Uncommented Issues</strong>.</p>
<p><strong>Untouched Issues</strong> on the other hand are <strong>open</strong>, non-owner issues which haven't been commented on and haven't been labeled, suggesting that no contributor has even acknowledged the issue.</p>
<p>As an open-source project contributor, it's important to keep on top of issues by organising them, responding to the issue openers. If you do, you're less likely to have people opening up duplicate issues, and less likely to miss important, high-priority bugs or great new ideas.</p>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div>
</div>
</div>
</head>
<body>
<div class="container" id="main-content">
<nav class="row header">
<div class="col-sm-10 forkability-header">
<h1><a href="/forkability">
<img src="pages/logo.svg">
Forkability
</a></h1>
</div>
<div class="col-sm-2 navigation-controls">
<button type="button" style="display:none;" class="btn btn-default sign-out">Sign out</button>
<a class="btn btn-social btn-sm btn-github sign-in"><i class="fa fa-github"></i> Sign in with GitHub</a>
</div>
</nav>
<div class="main-body">
</div>
</div>
<footer class="sticky-footer">
<div class="container">
<ul class="sticky-footer__info">
<li>Hacked together by <a href="https://github.com/basicallydan" title="Dan Hough on GitHub">@basicallydan</a></li>
<li>You can <a href="https://github.com/basicallydan/forkability" title="Forkability on GitHub">fork this on GitHub</a>.</li>
<li><a href="?u=basicallydan&r=forkability&l=nodejs" title="Forkability of Forkability">Forkability of basicallydan/forkability</a></li>
<li>Suggestions?? <a href="https://github.com/basicallydan/forkability/issues/new" target="_blank">Raise an issue</a></li>
<li><iframe src="//ghbtns.com/github-btn.html?user=basicallydan&repo=forkability&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="80px" height="20px"></iframe></li>
</ul>
</div>
</footer>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<!-- <script src="https://cdn.firebase.com/js/simple-login/1.6.3/firebase-simple-login.js"></script> -->
<script src="//getapi.co/scripts/github.js"></script>
<script type="text/javascript" src="pages/handlebars-v2.0.0.js"></script>
<!-- <script src="https://cdn.firebase.com/js/client/1.0.21/firebase.js"></script> -->
<script src="pages/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="dist/forkability.edge.js"></script>
<script type="text/javascript" src="pages/pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-47378781-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>