-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
546 lines (374 loc) · 25.4 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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
<!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="Building a New Feature in CC Search" />
<meta property="og:description" content="CC Search is an open source project and we welcome community involvement. Our active sprint, and backlog are public and we maintain a set of GitHub issues that we could use help with." />
<meta property="og:url" content="/cc-search/contribution-guide/" />
<meta property="og:type" content="article" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Building a New Feature in CC Search">
<meta name="twitter:description" content="CC Search is an open source project and we welcome community involvement. Our active sprint, and backlog are public and we maintain a set of GitHub issues that we could use help with.">
<meta name="twitter:site" content="@creativecommons">
<meta name="twitter:creator" content="@creativecommons">
<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>Building a New Feature in CC Search — Creative Commons on GitHub</title>
<body>
<div class="ga-script">
<div id="ga-script"></div>
<script type="text/javascript">
(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-2010376-37', 'auto');
ga('send', 'pageview');
</script>
</div>
<!-- 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/">
Blog
</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless ">
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/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/usability/">Usability</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless ">
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 ">
Internships<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/internships/">Overview</a>
<a class="navbar-item" href="/internships/project-ideas/">Project Ideas</a>
<a class="navbar-item" href="/internships/applicant-guide/">Applicant Guide</a>
<a class="navbar-item" href="/internships/intern-guide/">Intern Guide</a>
<a class="navbar-item" href="/internships/mentor-guide/">Mentor Guide</a>
<a class="navbar-item" href="/internships/history/">History</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless is-active">
CC Search<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/cc-search/">Overview & Roadmap</a>
<a class="navbar-item" href="/cc-search/contribution-guide/">Contribution Guide</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless ">Archives<i
class="icon caret-down"></i></a>
<div class="navbar-dropdown is-right">
<a class="navbar-item" href="/archives/old-tech-blog">CC Tech Blog (2007-2014)</a>
<a class="navbar-item" href="https://lists.ibiblio.org/pipermail/cc-devel/">cc-devel mailing list (2005-2015)</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="/cc-search/">
Cc Search
</a></li>
<!-- Active link -->
<li class="is-active"><a aria-current="page displayed">Contribution Guide</a></li>
</ul>
</nav>
</div>
<!-- Body -->
<div class="cc-search-guide">
<header class="header">
<div class="container is-paddingless">
<h1>Building a New Feature in CC Search</h1>
</div>
</header>
<div class="container body">
<div class="columns">
<div class="column is-one-quarter">
<div class="table-of-progress sticky-top">
<h4 class="step-header">Steps</h4>
<ul>
<li class="step">
<a class="link" href="#step-0">
<span class="number">0</span>
<span class="name">Evaluate Process</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-1">
<span class="number">1</span>
<span class="name">GitHub Issue</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-2">
<span class="number">2</span>
<span class="name">CC Response</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-3">
<span class="number">3</span>
<span class="name">Planning</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-4">
<span class="number">4</span>
<span class="name">Design</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-5">
<span class="number">5</span>
<span class="name">Dependencies</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-6">
<span class="number">6</span>
<span class="name">Code</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-7">
<span class="number">7</span>
<span class="name">Code Review</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-8">
<span class="number">8</span>
<span class="name">Staging</span>
</a>
</li>
<li class="step">
<a class="link" href="#step-9">
<span class="number">9</span>
<span class="name">Production</span>
</a>
</li>
</ul>
</div>
</div>
<div class="column content">
<p>CC Search is an open source project and we welcome community involvement. Our <a href="https://github.com/orgs/creativecommons/projects/7">active sprint</a>, and <a href="https://github.com/orgs/creativecommons/projects/10">backlog</a> are public and we maintain a set of GitHub issues that we could use help with.</p>
<p>We also want to enable you - our community members - to build features that would be useful to you, regardless of where those features are on our roadmap. However, we want to make sure any new feature fits into our product vision for CC Search, and we are a small team with limited bandwidth.</p>
<p>If you do want to build a new feature, and we would love it if you did, all we ask is that you follow the process outlined in this document to ensure a smooth experience for everyone involved.</p>
<h4 id="step-0">Step 0</h4><h2 id="evaluate-process">Evaluate Process</h2><h5 id="figure-out-if-you-need-to-follow-this-process.">Figure out if you need to follow this process.</h5><p>Please note that this process is only for adding significant features that require product input or infrastructural work from CC staff. If you are just fixing a bug or making an improvement to existing features, follow <a href="/contributing-code/">our much simpler guidelines for contributing code</a>. If you're not sure what category your proposed change falls under, ask us on GitHub or via <a href="/community/">our chat/mailing list</a>.</p>
<p>Examples that <em><strong>do not</strong></em> need to follow this process:</p>
<ul>
<li>Any issue marked "help wanted".</li>
<li>Improving the user experience or fixing bugs related to existing features (<a href="https://github.com/creativecommons/cccatalog-frontend/issues/141">example 1</a>, <a href="https://github.com/creativecommons/cccatalog-frontend/issues/184">example 2</a>)<ul>
<li><strong>Reasoning</strong>: It does not change the user experience in any significant way and does not require approval.</li>
</ul>
</li>
<li>Adding automated tests to the code<ul>
<li><strong>Reasoning</strong>: It is not a user facing change and does not remove or change existing functionality.</li>
</ul>
</li>
</ul>
<p>Examples that should follow this process:</p>
<ul>
<li>Adding a new content type (such as audio files) to CC Search<ul>
<li><strong>Reasoning</strong>: It changes the fundamental structure of CC Search and requires significant product input and infrastructural work from CC staff.</li>
</ul>
</li>
<li>Adding a new filter to the search results page<ul>
<li><strong>Reasoning</strong>: It is user facing and requires some product input and may require infrastructural work to collect the data that the search results will filter on.</li>
</ul>
</li>
</ul>
<h4 id="step-1">Step 1</h4><h2 id="github-issue">GitHub Issue</h2><h5 id="describe-the-feature-on-github.">Describe the feature on GitHub.</h5><p>Look through <a href="https://github.com/creativecommons/cccatalog-frontend/issues">our issues</a> to see if there is already a GitHub issue describing the feature you want to build. If none exists, create one on the <a href="https://github.com/creativecommons/cccatalog-frontend/issues">cccatalog-frontend</a> repository (which holds the code for CC Search) using the "Feature request" template.</p>
<p>On this GitHub issue, add a comment describing the feature you want to build and why you think it would be a good addition to CC Search. Add as much detail as you can.</p>
<h4 id="step-2">Step 2</h4><h2 id="cc-response">CC Response</h2><h5 id="wait-for-a-cc-staff-member-to-respond.">Wait for a CC staff member to respond.</h5><p>Someone on the CC Search staff will aim to review your comments within five business days and get back to you with one of these responses:</p>
<ul>
<li>Ask for more information</li>
<li>Preliminarily approve the feature</li>
<li>Reject the feature with an explanation and close the issue</li>
</ul>
<p>If at any time it has been more than five business days and you haven't received a response to your last message, please comment on the issue or <a href="/community/">contact us elsewhere</a>. Note that staff availability is limited during certain parts of the year, such as our annual CC Global Summit and our bi-annual staff retreats.</p>
<p>Once your feature has been preliminarily approved, proceed to Step 3.</p>
<h4 id="step-3">Step 3</h4><h2 id="planning">Planning</h2><h5 id="plan-your-work.">Plan your work.</h5><p>Create an implementation plan with the list of changes you'll need to make to implement your feature.</p>
<p>Keep in mind that CC Search heavily depends on the CC Catalog API (<a href="https://api.creativecommons.engineering/">docs</a>, <a href="https://github.com/creativecommons/cccatalog-api">code</a>) and the CC Catalog data (<a href="https://github.com/creativecommons/cccatalog">code</a>). You may need to make changes in one of those projects; you cannot add or modify data in CC Search if it is not provided by the API, and you cannot provide data through the API if it is not collected in the CC Catalog. Some tasks (such as setting up infrastructure or ingesting new data into the CC Catalog) can only be performed by CC staff; please highlight those dependencies. You don't have to do this step on your own; asking us questions or soliciting our opinions on aspects of your plan are encouraged.</p>
<p>Once your implementation plan is ready, update the GitHub issue and wait for a staff member to respond (per Step 2). If your work does not depend on any work by CC Staff, we will either approve your plan or provide feedback and ask you to make some changes. If your plan does depend on work by CC staff, we may reject it if it is infeasible for us to do that work in a reasonable time, otherwise we will provide feedback or approve it with a rough timeline of when we can complete the work that blocks you.</p>
<p>Once your plan has been approved, proceed to the next applicable step.</p>
<h4 id="step-4">Step 4</h4><h2 id="design">Design</h2><h5 id="get-design-and-ux-approved-if-applicable-.">Get Design and UX approved (if applicable).</h5><p>If your feature involves user-facing changes, please run these by us, either through wireframes or high fidelity mockups. We will either approve your design or provide feedback and ask you to make some changes.</p>
<p>Once your design has been approved, proceed to Step 5.</p>
<h4 id="step-5">Step 5</h4><h2 id="dependencies">Dependencies</h2><h5 id="wait-for-cc-staff-to-resolve-dependencies-if-applicable-.">Wait for CC staff to resolve dependencies (if applicable).</h5><p>If your feature depends on work that only CC staff can do, please wait for us to do that work. If you can start working on other parts of the feature in parallel, you may go ahead.</p>
<h4 id="step-6">Step 6</h4><h2 id="code">Code</h2><h5 id="write-your-code.">Write your code.</h5><p>At this point, CC staff and you should be on the same page about how the feature will be implemented and what it will look like. Here's where you get to actually implement it!</p>
<p>Commit early and often, follow <a href="/contributing-code/pr-guidelines/">our pull request and code guidelines</a>, and write tests!</p>
<h4 id="step-7">Step 7</h4><h2 id="code-review">Code Review</h2><h5 id="get-feedback-via-code-review.">Get feedback via code review.</h5><p>Once your pull request is ready, someone on CC staff will review your code and provide feedback. Once all feedback has been resolved, your code will be merged into the main branch of the repository.</p>
<p>You may have to do Steps 4-7 for multiple codebases in some cases, e.g. if your work includes both the CC Catalog API and CC Search, the API work will have to be done before the CC Search work that depends on it.</p>
<h4 id="step-8">Step 8</h4><h2 id="staging">Staging</h2><h5 id="get-feedback-via-live-testing.">Get feedback via live testing.</h5><p>Once your code is merged, it will be deployed to the staging server and tested manually (in addition to the comprehensive automated tests that you've already written). We may need to run some changes by our product counsel. This may produce an additional round of feedback for you to address.</p>
<h4 id="step-9">Step 9</h4><h2 id="production">Production</h2><h5 id="the-feature-is-live">The feature is live!</h5><p>Once any feedback from Step 8 is resolved, we will merge your code into the stable branch and deploy it to production. Congrats, your feature is live!</p>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="main-footer">
<div class="container">
<div class="columns">
<div class="column is-one-quarter">
<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-three-quarters">
<div class="columns">
<div class="column is-full">
<nav class="footer-navigation">
<ul class="menu">
<li>
<a href="/blog/" class="menu-item">Blog</a>
</li>
<li>
<a href="/contributing-code/" class="menu-item">Contribution Guidelines</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>
</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="http://creativecommons.org/donate">
<i class="icon cc-letterheart margin-right-small is-size-5 padding-top-smaller"></i>
Donate now
</a>
</aside>
</div>
</div>
</div>
</div>
</div>
</footer>
</body>