-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
236 lines (191 loc) · 15.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
<!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 href="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GJzZqFGwb1QTTN6wy59ffF1BuGJpLSa9DkKMp0DgiMDm4iYMj70gZWKYbI706tWS" crossorigin="anonymous">
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700" rel="stylesheet">
<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="Contribution Guidelines" />
<meta property="og:description" content="Thank you for your interest in contributing to Creative Commons open source projects!" />
<meta property="og:url" content="/contributing-code/" />
<meta property="og:type" content="article" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Contribution Guidelines">
<meta name="twitter:description" content="Thank you for your interest in contributing to Creative Commons open source projects!">
<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>
<title>Contribution Guidelines — 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 class="main-header">
<div class="container-fluid">
<div class="row justify-content-md-center">
<div class="col-lg-9 col-md-9 col-sm-12">
<nav class="navbar navbar-expand-xl navbar-dark" name="top">
<a class="navbar-brand" href="/">
<img src="/cclogo.svg">
<span class="legend">Creative Commons Open Source</span>
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent"
aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="/blog/">Blog</a>
</li>
<li class="nav-item dropdown active">
<a class="nav-link" href="#" id="navbarContributingCodeDropdown" role="button">Contribute</a>
<div class="dropdown-menu" aria-labelledby="navbarContributingCodeDropdown">
<a class="dropdown-item" href="/contributing-code/">Contribution Guidelines</a>
<a class="dropdown-item" href="/contributing-code/projects/">Project List</a>
<a class="dropdown-item" href="/contributing-code/pr-guidelines/">Pull Request Guidelines</a>
<a class="dropdown-item" href="/contributing-code/github-repo-guidelines/">GitHub Repo Guidelines</a>
<a class="dropdown-item" href="/contributing-code/cc-search/">CC Search</a>
</div>
</li>
<li class="nav-item dropdown ">
<a class="nav-link" href="#" id="navbarCommunityDropdown" role="button">Community</a>
<div class="dropdown-menu" aria-labelledby="navbarCommunityDropdown">
<a class="dropdown-item" href="/community/">Join the Community</a>
<a class="dropdown-item" href="/community/community-team/">Community Team</a>
<a class="dropdown-item" href="/community/community-team/members/">Community Team Members</a>
<a class="dropdown-item" href="/community/community-team/project-roles/">Project Roles</a>
<a class="dropdown-item" href="/community/community-team/community-building-roles/">Community Building Roles</a>
<a class="dropdown-item" href="/community/write-a-blog-post/">Write a Blog Post</a>
<a class="dropdown-item" href="/community/code-of-conduct/">Code of Conduct</a>
<a class="dropdown-item" href="/community/code-of-conduct/enforcement/">Code of Conduct Enforcement</a>
</div>
</li>
<li class="nav-item dropdown ">
<a class="nav-link" href="#" id="navbarInternshipsDropdown" role="button">Internships</a>
<div class="dropdown-menu" aria-labelledby="navbarInternshipsDropdown">
<a class="dropdown-item" href="/internships/">Overview</a>
<a class="dropdown-item" href="/internships/project-ideas/">Project Ideas</a>
<a class="dropdown-item" href="/internships/applicant-guide/">Applicant Guide</a>
<a class="dropdown-item" href="/internships/intern-guide/">Intern Guide</a>
<a class="dropdown-item" href="/internships/mentor-guide/">Mentor Guide</a>
<a class="dropdown-item" href="/internships/history/">History</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link" href="/cc-search/">CC Search</a>
</li>
<li class="nav-item dropdown ">
<a class="nav-link" href="#" id="navbarArchivesDropdown" role="button">Archives</a>
<div class="dropdown-menu" aria-labelledby="navbarArchivesDropdown">
<a class="dropdown-item" href="/archives/old-tech-blog">CC Tech Blog (2007-2014)</a>
<a class="dropdown-item" href="https://lists.ibiblio.org/pipermail/cc-devel/">cc-devel mailing list (2005-2015)</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link" href="https://creativecommons.org" target="_blank">creativecommons.org</a>
</li>
</ul>
</nav>
</div>
<a href="https://github.com/creativecommons/creativecommons.github.io-source" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; left: 0; transform: scale(-1, 1);" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg>
</a>
</div>
</div>
</header>
<div class="container-fluid page-content">
<div class="row justify-content-md-center">
<div class="col-lg-9 col-md-9 col-sm-12 content-wrap">
<div class="page py-3">
<h1 class="page-title pb-3 mb-4">Contribution Guidelines</h1>
<div class="card toc-card bg-light">
<div class="card-body">
<ul class="toc list-unstyled">
<li><a href="#finding-an-issue">Finding an issue</a></li>
<li><a href="#contribution-process">Contribution process</a></li>
<li><a href="#proposing-a-new-issue">Proposing a new issue</a></li>
</ul>
</div>
</div>
<p class="lead">Thank you for your interest in contributing to Creative Commons open source projects!</p><p>We do all of our development <a href="https://github.com/creativecommons/">on GitHub</a>. If you are not familiar with GitHub or pull requests, <a href="https://guides.github.com/activities/hello-world/">here is an excellent guide to get started</a>.</p>
<h2 id="finding-an-issue">Finding an issue</h2><p>Here's a list of <a href="/projects">all our current projects</a>. We use GitHub issues associated with each project to track the work associated with that project. That's where you can find things to work on.</p>
<p>We make extensive use of issue labels to desginate the status of various issues. We have a standard set of labels across all projects, <a href="https://github.com/creativecommons/ccos-scripts/blob/master/normalize_repos/labels.py">documented here</a>. Here are some of the ones that are most relevant to finding a good issue to work on:</p>
<ul>
<li><strong>Issues tagged <code>help wanted</code> or <code>good first issue</code></strong> are available for community contribution**<ul>
<li>These issues are available for community contribution and you do not need our permission to work on one of these.</li>
<li>You may work on an issue labeled <code>good first issue</code> even if it's not your first issue.</li>
<li>Check the issue comments/labels to see whether someone else has indicated that they are working on it. If someone is already working on it and there has been activity within the last 7 days, you may want to find a different issue to work on.</li>
</ul>
</li>
<li><strong>Issues tagged with one of these labels: <code>blocked</code>, <code>not ready for work</code>, <code>ticket work required</code>, <code>CC staff only</code> are not available to the community. Do not work on these.</strong><ul>
<li>Issues tagged <code>blocked</code> are blocked by other work that needs to be done first.</li>
<li>Issues tagged <code>not ready for work</code> or <code>ticket work required</code> need additional work done on the issue before they can be opened to community contributors.</li>
<li>Issues tagged <code>CC staff only</code> are not suitable for community contribution, usually because it requires infrastructure access or institutional knowledge that would be impractical to provide to the community.</li>
</ul>
</li>
<li><strong>Issues without any of the above labels <em>may</em> be open for contribution.</strong><ul>
<li>Please add a comment to ask whether the issue is available before starting work.</li>
</ul>
</li>
</ul>
<p>Some helpful saved searches on GitHub than can assist with finding an issue:</p>
<ul>
<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">issues labeled "good first issue"</a></li>
<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">issues labeled "help wanted"</a></li>
<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+-label%3A%22in+progress%22">issues labeled "help wanted", and not labeled as "in progress"</a></li>
<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Apr+is%3Aopen+label%3A%22help+wanted%22">incomplete pull requests labeled "help wanted"</a></li>
</ul>
<h2 id="contribution-process">Contribution process</h2><p>Once you've found an issue you'd like to work on, please follow these steps to make your contribution:</p>
<ol>
<li>Comment on it and say you're working on that issue. This is to avoid conflicts with others also working on the issue.<ul>
<li>A project maintainer may mark the issue with an <code>in progress</code> label at this point, but we don't always get around to that.</li>
</ul>
</li>
<li>Write your code and submit your pull request. Be sure to read and follow our <strong><a href="/contributing-code/pr-guidelines">pull request guidelines</a></strong>!</li>
<li>Wait for code review and address any issues raised as soon as you can.</li>
</ol>
<p><strong>A note on collaboration:</strong> We encourage people to collaborate as much as possible. We especially appreciate contributors reviewing each others pull requests, as long as you are <a href="https://medium.com/@otarutunde/comments-during-code-reviews-2cb7791e1ac7">kind and constructive</a> when you do so.</p>
<h2 id="proposing-a-new-issue">Proposing a new issue</h2><p>If you want to work on something that there is no GitHub issue for, follow these steps:</p>
<ol>
<li>Create a a new GitHub issue associated with the relevant repository and propose your change there. Be sure to include implementation details and the rationale for the proposed change.<ul>
<li>We are very reluctant to accept random pull requests without a related issue created first.</li>
</ul>
</li>
<li>The issue will automatically have the <code>not ready for work</code> label applied. Wait for a project maintainer to evaluate your issue and decide whether it's something that we will accept a pull request for.</li>
<li>Once the project maintainer has approved the issue and removed the <code>not ready for work</code> label, you may start work on code as described in the "Contribution process" section above.</li>
</ol>
<p>When in doubt, ask a question on <a href="/community">one of our community forums</a>.</p>
<a id="back-to-top" href="#top" class="btn btn-dark btn-sm" role="button">Back to top</a>
</div>
</div>
</div>
</div>
<footer class="main-footer bg-dark">
<div class="container-fluid">
<div class="row justify-content-md-center">
<div class="col-lg-9 col-md-9 col-sm-12 footer text-light py-4 px-3">
<small>
<p><a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License"
style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a></p>
<p class="text-muted">All the content on this website is licensed under a <strong><a rel="license"
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International
License</a></strong> unless otherwise specified.</p>
</small>
</div>
</div>
</div>
</footer>
</body>