-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
162 lines (151 loc) · 10.3 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
<html>
<head>
<link rel="stylesheet" href="index.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Condensed:400,700">
<script src="index.js" type="text/javascript"></script>
</head>
<body>
<div id="container">
<div id="title">
<h1>Status report</h1>
</div>
<div id="badge">
<img src="" />
</div>
<div id="repository" class="recommendation">
<div class="compliant hidden">
<span class="symbol">☑</span>
<h2>Use a publicly accessible repository with version control</h2>
<p>
<span class="compliment">Well done. </span>Developing scientific software in publicly accessible
repositories enables early involvement of users, helps build collaborations, contributes to the
reproducibility of results generated by the software, facilitates software reusability, and
contributes to improving software quality.
</p>
</div>
<div class="noncompliant">
<span class="symbol">☒</span>
<h2>Use a publicly accessible repository with version control</h2>
<h3>Why is this important</h3>
<p>
<h4>Why public</h4>
Developing scientific software in publicly accessible repositories enables early involvement of
users, helps build collaborations, contributes to the reproducibility of results generated by the
software, facilitates software reusability, and contributes to improving software quality. Taken
together, this ensures that your software has the best chance of being used by as many people as
possible while promoting transparency.
</p>
<p>
<h4>Why version control</h4>
Using a version control system allows you to easily track changes in your software, both your own
changes as well as those made by collaborators. There are many flavors of version control systems,
ranging from older systems such as CVS and Subversion to more modern ones such as Git, Mercurial,
and Bazaar. By configuring your version control system to use GitHub, GitLab or Bitbucket, you'll
even have backups of every version of the software you ever made. Additionally, those platforms
offer collaboration tools such as an issue tracker and project management tools, and you'll be able
to use third-party services such as code quality checkers, correctness checkers, and a lot more.
</p>
<h3>Help me choose</h3>
<p>
Git is the most feature-rich, most modern and most popular version control system by a good margin,
and we heartily recommend you use it for all your version control needs. To get the best out of Git,
use it in combination with GitHub.com, Bitbucket.org, or GitLab.com.
</p>
<ul>
<li><a href="https://swcarpentry.github.io/git-novice/" target="_blank">How to get started with git</a></li>
<li><a href="https://software.ac.uk/choosing-repository-your-software-project" target="_blank">Choosing a platform for your software project</a></li>
<li><a href="https://github.com/" target="_blank">GitHub.com</a></li>
<li><a href="https://bitbucket.org/" target="_blank">BitBucket.org</a></li>
<li><a href="https://gitlab.com/" target="_blank">GitLab.com</a></li>
</ul>
</div>
</div>
<div id="license" class="recommendation">
<div class="compliant hidden">
<span class="symbol">☑</span>
<h2>Add a license</h2>
<p>
<span class="compliment">Well done. </span>Including a license is necessary if you want others to make use of your work.
</p>
</div>
<div class="noncompliant">
<span class="symbol">☒</span>
<h2>Add a license</h2>
<h3>Why is this important</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus in enim lobortis diam vehicula ultricies. Phasellus ornare purus nec dolor dapibus, ut eleifend erat aliquet. Duis facilisis dolor non erat semper pellentesque. Sed gravida non libero vitae tincidunt. In consequat sed ex at interdum. Proin mattis eu felis sed euismod. Nunc lacinia posuere mattis.
</p>
<h3>Help me choose</h3>
<p>
Aenean quam est, egestas in sagittis in, hendrerit vel justo. Sed metus libero, auctor tincidunt metus eget, suscipit dignissim libero. Aenean non vehicula ante. Duis varius dictum ante vel feugiat. Donec non hendrerit orci. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum maximus justo a odio vestibulum, sit amet fringilla orci pharetra.
</p>
</div>
</div>
<div id="registry" class="recommendation">
<div class="compliant hidden">
<span class="symbol">☑</span>
<h2>Register your code in a community registry</h2>
<p>
<span class="compliment">Well done. </span>You made it easier for others to discover your work via search engines.
</p>
</div>
<div class="noncompliant">
<span class="symbol">☒</span>
<h2>Register your code in a community registry</h2>
<h3>Why is this important</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus in enim lobortis diam vehicula ultricies. Phasellus ornare purus nec dolor dapibus, ut eleifend erat aliquet. Duis facilisis dolor non erat semper pellentesque. Sed gravida non libero vitae tincidunt. In consequat sed ex at interdum. Proin mattis eu felis sed euismod. Nunc lacinia posuere mattis.
</p>
<h3>Help me choose</h3>
<p>
Aenean quam est, egestas in sagittis in, hendrerit vel justo. Sed metus libero, auctor tincidunt metus eget, suscipit dignissim libero. Aenean non vehicula ante. Duis varius dictum ante vel feugiat. Donec non hendrerit orci. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum maximus justo a odio vestibulum, sit amet fringilla orci pharetra.
</p>
</div>
</div>
<div id="citation" class="recommendation">
<div class="compliant hidden">
<span class="symbol">☑</span>
<h2>Enable citation of the software</h2>
<p>
<span class="compliment">Well done. </span> Enabling citation helps you get recognition for your work.
</p>
</div>
<div class="noncompliant">
<span class="symbol">☒</span>
<h2>Enable citation of the software</h2>
<h3>Why is this important</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus in enim lobortis diam vehicula ultricies. Phasellus ornare purus nec dolor dapibus, ut eleifend erat aliquet. Duis facilisis dolor non erat semper pellentesque. Sed gravida non libero vitae tincidunt. In consequat sed ex at interdum. Proin mattis eu felis sed euismod. Nunc lacinia posuere mattis.
</p>
<h3>Help me choose</h3>
<p>
Aenean quam est, egestas in sagittis in, hendrerit vel justo. Sed metus libero, auctor tincidunt metus eget, suscipit dignissim libero. Aenean non vehicula ante. Duis varius dictum ante vel feugiat. Donec non hendrerit orci. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum maximus justo a odio vestibulum, sit amet fringilla orci pharetra.
</p>
</div>
</div>
<div id="checklist" class="recommendation">
<div class="compliant hidden">
<span class="symbol">☑</span>
<h2>Use a software quality checklist</h2>
<p>
<span class="compliment">Well done. </span>Including a checklist is a good way to guide you on your path of continuous improvement, while showing that you are not afraid to be transparent about your work.
</p>
</div>
<div class="noncompliant">
<span class="symbol">☒</span>
<h2>Use a software quality checklist</h2>
<h3>Why is this important</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus in enim lobortis diam vehicula ultricies. Phasellus ornare purus nec dolor dapibus, ut eleifend erat aliquet. Duis facilisis dolor non erat semper pellentesque. Sed gravida non libero vitae tincidunt. In consequat sed ex at interdum. Proin mattis eu felis sed euismod. Nunc lacinia posuere mattis.
</p>
<h3>Help me choose</h3>
<p>
Aenean quam est, egestas in sagittis in, hendrerit vel justo. Sed metus libero, auctor tincidunt metus eget, suscipit dignissim libero. Aenean non vehicula ante. Duis varius dictum ante vel feugiat. Donec non hendrerit orci. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum maximus justo a odio vestibulum, sit amet fringilla orci pharetra.
</p>
</div>
</div>
<div id="footer">
</div>
</div>
</body>
</html>