-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
532 lines (391 loc) · 23.8 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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
<!doctype html>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" type="image/x-icon" href="/static/favicon.ico">
<link rel="stylesheet" href="/static/gen/style.css">
<link rel="stylesheet" href="/static/pygments.css">
<meta property="og:site_name" content="Creative Commons" />
<meta property="og:title" content="GitHub Repo Guidelines" />
<meta property="og:description" content="This is a checklist for all public repositories hosted on the
Creative Commons GitHub organization. Not
all repositories meet these criteria yet. Please notify us if a project you'd
like to work on does not meet this checklist by opening a GitHub issue
associated with the repository." />
<meta property="og:url" content="/contributing-code/github-repo-guidelines/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://cc-og-image.vercel.app/GitHub Repo Guidelines.png?&md=1&fontFamily=roboto-condensed&fontSize=100px&images=https%3A%2F%2Fcc-vocabulary.netlify.app%2Flogos%2Fproducts%2Fopen_source.svg%23opensource" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="GitHub Repo Guidelines">
<meta name="twitter:description" content="This is a checklist for all public repositories hosted on the
Creative Commons GitHub organization. Not
all repositories meet these criteria yet. Please notify us if a project you'd
like to work on does not meet this checklist by opening a GitHub issue
associated with the repository.">
<meta name="twitter:site" content="@creativecommons">
<meta name="twitter:creator" content="@creativecommons">
<meta name="monetization" content="$ilp.uphold.com/edR8erBDbRyq">
<script src="https://code.jquery.com/jquery-3.3.1.min.js"
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k" crossorigin="anonymous"></script>
<script type="text/javascript" src="/static/gen/script.js"></script>
<script src="https://unpkg.com/@creativecommons/vocabulary@2020.7.2/js/vocabulary.js"></script>
<script>
const globalHeaderInstance = vocabulary.createGlobalHeader();
</script>
<title>GitHub Repo Guidelines — Creative Commons Open Source</title>
<body>
<!-- Header -->
<header class="container">
<nav class="navbar">
<div class="navbar-brand">
<a class="has-text-black" href="/">
<svg
class="logo margin-top-small"
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 284 46">
<use href="#opensource"></use>
</svg>
</a>
<a role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
</div>
<div class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item " href="/blog/entries/">
Blog
</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless is-active" tabindex="0">
Contribute<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/contributing-code/">Contribution Guidelines</a>
<a class="navbar-item" href="/contributing-code/projects/">Project List</a>
<a class="navbar-item" href="/contributing-code/issue-finder/">Issue Finder</a>
<a class="navbar-item" href="/contributing-code/pr-guidelines/">Pull Request Guidelines</a>
<a class="navbar-item" href="/contributing-code/github-repo-guidelines/">GitHub Repo Guidelines</a>
<a class="navbar-item" href="/contributing-code/repo-labels/">Repository Labels</a>
<a class="navbar-item" href="/contributing-code/javascript-guidelines/">JavaScript Guidelines</a>
<a class="navbar-item" href="/contributing-code/python-guidelines/">Python Guidelines</a>
<a class="navbar-item" href="/contributing-code/translation-guide/">Translation Guide</a>
<a class="navbar-item" href="/contributing-code/usability/">Usability</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Community<i class="icon caret-down"></i></a>
<div class="navbar-dropdown is-active">
<a class="navbar-item" href="/community/">Join the Community</a>
<a class="navbar-item" href="/community/community-team/">Community Team</a>
<a class="navbar-item" href="/community/community-team/members/">Community Team Members</a>
<a class="navbar-item" href="/community/community-team/project-roles/">Project Roles</a>
<a class="navbar-item" href="/community/community-team/community-building-roles/">Community Building Roles</a>
<a class="navbar-item" href="/community/write-a-blog-post/">Write a Blog Post</a>
<a class="navbar-item" href="/community/code-of-conduct/">Code of Conduct</a>
<a class="navbar-item" href="/community/code-of-conduct/enforcement/">Code of Conduct Enforcement</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Work Programs<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/programs/">Overview</a>
<a class="navbar-item" href="/programs/project-ideas/">Project Ideas</a>
<a class="navbar-item" href="/programs/applicant-guide/">Applicant Guide</a>
<a class="navbar-item" href="/programs/contrib-guide/">Contributor Guide</a>
<a class="navbar-item" href="/programs/lead-guide/">Project Lead Guide</a>
<a class="navbar-item" href="/programs/history/">History</a>
</div>
</div>
</div>
</div>
</nav>
</header>
<!-- Breadcrumb -->
<div class="breadcrumb-container">
<nav class="container breadcrumb caption bold" aria-label="breadcrumbs">
<ul>
<!-- Extracting the slugs of URL -->
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/">
Home
</a></li>
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/contributing-code/">
Contributing Code
</a></li>
<!-- Active link -->
<li class="is-active"><a aria-current="page displayed">GitHub Repo Guidelines</a></li>
</ul>
</nav>
</div>
<!-- Body -->
<div class="code-guidelines">
<header class="header">
<div class="container is-paddingless">
<h1>GitHub Repo Guidelines</h1>
<div class="description column is-9 is-paddingless">
<p>This is a checklist for all public repositories hosted on the
<a href="https://github.com/creativecommons">Creative Commons GitHub organization</a>. Not
all repositories meet these criteria yet. Please notify us if a project you'd
like to work on does not meet this checklist by opening a GitHub issue
associated with the repository.</p>
</div>
</div>
</header>
<div class="container code-guidelines-body">
<div class="columns">
<div class="column is-one-quarter">
<div class="row">
<aside class="menu sidebar-menu">
<ul class="menu-list">
<li>
<a class=" link" href="/contributing-code/projects/">Project List</a>
</li>
<hr class="divider">
<li>
<a class=" link" href="/contributing-code/issue-finder/">Issue Finder</a>
</li>
<hr class="divider">
<li>
<a class=" link" href="/contributing-code/">Contribution Guidelines</a>
<ul>
<li><a class=" link" href="/contributing-code/pr-guidelines/"><i class="icon circle-filled"></i>Pull Request Guidelines</a></li>
<li><a class=" is-active link" href="/contributing-code/github-repo-guidelines/"><i class="icon circle-filled"></i>GitHub Repo Guidelines</a></li>
<li><a class=" link" href="/contributing-code/repo-labels/"><i class="icon circle-filled"></i>Repository Labels</a></li>
<li><a class=" link" href="/contributing-code/javascript-guidelines/"><i class="icon circle-filled"></i>JavaScript Guidelines</a></li>
<li><a class=" link" href="/contributing-code/python-guidelines/"><i class="icon circle-filled"></i>Python Guidelines</a></li>
<li><a class=" link" href="/contributing-code/translation-guide/"><i class="icon circle-filled"></i>Translation Guide</a></li>
</ul>
</li>
<hr class="divider">
<li>
<a class=" link" href="/contributing-code/usability/">Usability</a>
</li>
</ul>
</aside>
</div>
<div class="row padding-bottom-normal sticky-top">
<h4 class="b-header">On this page</h4>
<aside class="menu table-of-contents">
<ul class="menu-list">
<li>
<a class="link" href="#required-items">Required Items</a>
<ul>
<li><a class="link" href="#files"><i class="icon circle-filled"></i>Files</a></li>
<li><a class="link" href="#additional-items"><i class="icon circle-filled"></i>Additional Items</a></li>
</ul>
</li>
<li>
<a class="link" href="#optional-items">Optional items</a>
</li>
<li>
<a class="link" href="#standard-labels">Standard Labels</a>
</li>
<li>
<a class="link" href="#branch-protections">Branch Protections</a>
</li>
<li>
<a class="link" href="#cc-metadata-file">CC Metadata file</a>
</li>
</ul>
</aside>
</div>
</div>
<div class="column content is-three-quarters">
<h2 id="required-items">Required Items</h2><p>All GitHub repositories should have the following items to be considered fully
ready for external contributors.</p>
<h3 id="files">Files</h3><ul>
<li><code>/.github/CODEOWNERS</code>: Defined code owners<ul>
<li><a href="https://help.github.com/en/articles/about-code-owners">About code owners - GitHub Help</a></li>
</ul>
</li>
<li><code>/.cc-metadata.yml</code>: The standard <a href="/contributing-code/github-repo-guidelines/#cc-metadata-file">CC metadata YAML file</a>.</li>
<li><code>/CODE_OF_CONDUCT.md</code>: Code of Conduct<ul>
<li>Feel free to use our standard <a href="https://github.com/creativecommons/vocabulary/blob/main/CODE_OF_CONDUCT.md"><code>CODE_OF_CONDUCT.md</code></a> file from
<a href="https://github.com/creativecommons/.github">creativecommons/.github</a><ul>
<li><a href="https://help.github.com/en/articles/adding-a-code-of-conduct-to-your-project">Adding a code of conduct to your project - GitHub Help</a></li>
</ul>
</li>
</ul>
</li>
<li><code>/LICENSE</code>: license file.</li>
<li><code>/CONTRIBUTING.md</code>: contributor guidelines<ul>
<li>Can be project-specific or our standard <a href="https://github.com/creativecommons/vocabulary/blob/main/CONTRIBUTING.md"><code>CONTRIBUTING.md</code></a>
file from <a href="https://github.com/creativecommons/.github">creativecommons/.github</a></li>
<li><a href="https://help.github.com/en/articles/setting-guidelines-for-repository-contributors">Setting guidelines for repository contributors - GitHub
Help</a></li>
</ul>
</li>
<li><code>/README.md</code>: read me information file<ul>
<li>Must documents how to install and build the project locally and documents a
high level overview of the project and code structure. It should also link
to any other available documentation.</li>
</ul>
</li>
<li><strong>All pull request templates must include the full text of the <a href="https://developercertificate.org/">DCO</a>.</strong></li>
</ul>
<h3 id="additional-items">Additional Items</h3><ul>
<li>CI and code style linters that run automatically whenever new code is pushed
(if applicable to the project).</li>
<li>At least a couple of automated tests (if applicable to the project).</li>
</ul>
<h2 id="optional-items">Optional items</h2><ul>
<li><a href="https://help.github.com/en/articles/creating-issue-templates-for-your-repository">Issue templates</a>. GitHub pulls the default templates from
our <a href="https://github.com/creativecommons/.github"><code>.github</code> repository</a> automatically, but if you want/need to
customize them, create them in your repository.</li>
<li>A <a href="https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository">pull request template</a>. GitHub pulls the default template
from our <a href="https://github.com/creativecommons/.github"><code>.github</code> repository</a> automatically, but if you
want/need to customize it, create it in your repository.</li>
<li><a href="https://help.github.com/en/articles/adding-support-resources-to-your-project">Support resources</a>. GitHub pulls the default <code>SUPPORT.md</code>
file from our <a href="https://github.com/creativecommons/.github"><code>.github</code> repository</a> automatically, but if you
want/need to customize it, create it in your repository.</li>
</ul>
<h2 id="standard-labels">Standard Labels</h2><p>All repositories must contain a set of standard labels, <a href="/contributing-code/repo-labels/">documented
here</a>, which comprise of common labels in
addition to repository-specific skill labels. You don't have to set these up
manually. The labels are <a href="https://github.com/creativecommons/ccos-scripts">automatically
managed</a> on all CC
repositories, and so, must not be renamed.</p>
<p>Repositories may contain additional custom labels as well which will remain
unaffected by the sync. It is recommended that custom labels be explained in
the contribution guidelines for that project.</p>
<h2 id="branch-protections">Branch Protections</h2><p>Branch protections are automatically set up by CC staff via
<a href="https://github.com/creativecommons/ccos-scripts">creativecommons/ccos-scripts</a>.
By default, pushing directly to the <em>default branch</em> (ex. <code>main</code>) is disabled
and all pull requests require review by at least one person before merge.</p>
<h2 id="cc-metadata-file">CC Metadata file</h2><p>Each repo should have a <code>.cc-metadata.yml</code> file in the root directory with the
following structure:</p>
<div class="hll"><pre><span></span><span class="c1"># Whether this GitHub repo is for a CC-led engineering project</span>
<span class="nt">engineering_project</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="c1"># Name of the repository/project in English</span>
<span class="nt">english_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">CC Catalog API</span>
<span class="c1"># All technologies used</span>
<span class="nt">technologies</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Python, Django, Django REST Framework, Elasticsearch</span>
<span class="c1"># Whether this repository should be featured on the CC Open Source site's "Projects" page</span>
<span class="nt">featured</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="c1"># Slack channel name (optional key)</span>
<span class="nt">slack</span><span class="p">:</span><span class="w"> </span><span class="s">'cc-dev-catalog'</span>
</pre></div>
<p>This metadata file is used in the <a href="/projects/">Projects</a> page. Repos that are
marked as non-engineering projects are not displayed in the page and repos
marked as featured as displayed at the top of the page. Repos should be marked
as featured if we are actively looking for community contributions and have the
bandwidth to review them quickly.</p>
<p>Repos without this metadata file are treated as <code>engineering_projects: true</code>,
<code>featured: false</code> and <code>slack: ""</code>. A default is necessary since it will take
time for us to clean up and add metadata to all our repos.</p>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="main-footer">
<div class="container">
<div class="columns">
<div class="column is-one-third-tablet-only is-one-quarter-desktop">
<a href="https://creativecommons.org" class="main-logo margin-bottom-bigger">
<span class="has-text-white">
<svg
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 304 73">
<use href="#logomark"></use>
</svg>
</span>
</a>
<div>
<address class="margin-bottom-normal">Creative Commons<br />PO Box 1866, Mountain View CA 94042</address>
<a href="mailto:info@creativecommons.org" class="mail">info@creativecommons.org</a><br />
<a href="tel://+1-415-429-6753" class="phone">+1-415-429-6753</a>
</div>
<div class="margin-vertical-large">
<a href="https://www.instagram.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">instagram</i>
</a>
<a href="https://www.twitter.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">twitter</i>
</a>
<a href="https://www.facebook.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">facebook</i>
</a>
<a href="https://www.linkedin.com/company/creative-commons/" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">linkedin</i>
</a>
</div>
</div>
<div class="column is-two-third-tablet-only is-three-quarters-desktop">
<div class="columns">
<div class="column is-full">
<nav class="footer-navigation">
<ul class="menu">
<li>
<a href="/blog/entries/" class="menu-item">Blog</a>
</li>
<li>
<a href="/community/community-team/" class="menu-item">Community Team</a>
</li>
<li>
<a href="/contributing-code/projects/" class="menu-item">Project List</a>
</li>
<li>
<a href="/archives/" class="menu-item">Archives</a>
</li>
</ul>
</nav>
</div>
</div>
<div class="columns">
<div class="column is-two-thirds">
<div class="subscription">
<h5 class="b-header">Subscribe to our newsletter</h5>
<form class="newsletter">
<input type="text" class="input" placeholder="Your email">
<input type="submit" value="subscribe" class="button small">
</form>
</div>
<div class="attribution margin-top-bigger">
<p class="caption">
Except where otherwise
<a href="https://creativecommons.org/policies#license" target="_blank" rel="noopener">noted</a>,
content on this site is licensed under a
<a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noopener">Creative Commons
Attribution 4.0 International license</a>.
<a href="https://creativecommons.org/website-icons" target="_blank" rel="noopener">Icons</a>
by
<a href="https://fontawesome.com/" target="_blank" rel="noopener">Font Awesome</a>.
</p>
<div class="margin-top-smaller">
<i class="icon margin-right-small is-size-4">cclogo</i>
<i class="icon margin-right-small is-size-4">ccby</i>
</div>
</div>
</div>
<div class="column is-one-third">
<aside class="donate-section">
<h5>Our work relies on you!</h5>
<p>Help us keep the internet free and open.</p>
<a class="button small donate" href="https://creativecommons.org/donate?c_src=website&c_src2=GlobalFooter">
<i class="icon cc-letterheart-filled margin-right-small is-size-5 padding-top-smaller"></i>
Donate now
</a>
</aside>
</div>
</div>
</div>
</div>
</div>
</footer>
</body>