-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
184 lines (154 loc) · 14 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
<!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">
<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>Contributing Code — Creative Commons on GitHub</title>
<body>
<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 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-9">
<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="/">Home</a>
</li>
<li class="nav-item dropdown active">
<a class="nav-link" href="#" id="navbarContributingCodeDropdown" role="button">Contributing Code</a>
<div class="dropdown-menu" aria-labelledby="navbarContributingCodeDropdown">
<a class="dropdown-item" href="/contributing-code/">Overview</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>
</div>
</li>
<li class="nav-item">
<a class="nav-link" href="/projects/">Projects</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/blog/">Blog</a>
</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/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">
<a class="nav-link" href="/programs/outreachy/2019-12-start/">Outreachy</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="/gsoc-2019">GSoC 2019</a>
<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">CC</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="container-fluid page-content">
<div class="row justify-content-md-center">
<div class="col-9 content-wrap">
<div class="page py-3">
<h1 class="page-title pb-3 mb-4">Contributing Code</h1>
<div class="card toc-card bg-light">
<div class="card-body">
<ul class="toc list-unstyled">
<li><a href="#working-on-an-existing-project">Working on an existing project</a></li>
<ul class="toc list-unstyled pl-4">
<li><a href="#working-on-open-issues">Working on open issues</a></li>
<li><a href="#proposing-a-new-issue">Proposing a new issue</a></li>
</ul>
<li><a href="#new-projects">New projects</a></li>
</ul>
</div>
</div>
<p>We do all of our development on GitHub and are generally open to pull requests and proposals for new community-maintained projects.</p>
<p>We would especially like help with reviving projects that CC's engineering team does not have the time to actively work on (such as <a href="https://github.com/creativecommons/creativecommons-wordpress-plugin">our WordPress plugin</a> and <a href="https://github.com/creativecommons/cc-license-chooser">license chooser widget</a>). We're also looking to improve our documentation and increase our automated test coverage across pretty much all our projects, so help with that would be greatly appreciated.</p>
<p>Please follow our <a href="/contributing-code/pr-guidelines">pull request guidelines</a> when submitting code. 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="working-on-an-existing-project">Working on an existing project</h2><p>Here's a list of <a href="/projects">all our current projects</a>.</p>
<p>We are actively working on documenting and licensing them and adding self-contained contribution guidelines but we still have a lot of work ahead of us. We're open to contributions on any of our public projects, as long as they have a license. The license for a project is located in a file named <code>LICENSE</code> in the root directory of the repository. If the repository you want to contribute to has no license file, please create a GitHub issue attached to that repository and we'll prioritize setting those up.</p>
<p>You may also create GitHub issues for any other missing infrastructure such as a <code>README</code> file.</p>
<h3 id="working-on-open-issues">Working on open issues</h3><p>We track all our work via the GitHub issues associated with a repository and that's where you can find things to work on. First, check the labels on the issue you're interested in:</p>
<ul>
<li>Issues labeled <strong>"in progress"</strong> are generally not available, but may be available if there has been no activity on the issue or related PR for over a week.</li>
<li>Issues labeled <strong>"help wanted"</strong> or <strong>"good first issue"</strong> have been identified as available for community contribution. Feel free to work on issues labeled "good first issue" even if it is not your first issue.<ul>
<li>Here's a list of <a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">all issues labeled "good first issue"</a></li>
<li>Here are lists of <a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">all issues labeled "help wanted"</a> and <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>
</li>
<li>If the issue does not have either of those labels, it may still be open for contribution.</li>
</ul>
<p>Once you have identified an issue you'd like to work on, follow these steps:</p>
<ol>
<li>Comment on it and say you'd like to work on that issue.</li>
<li>Wait for someone to confirm that you may work on the issue before writing any code. The person who confirms will add an "in progress" label to the issue to indicate that the issue has been assigned.</li>
<li>Once the issue has been updated to "in progress", 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>Even if you're not done with the issue, create a <a href="https://help.github.com/en/articles/about-pull-requests#draft-pull-requests">draft pull request</a> and push your code <a href="https://www.worklytics.co/blog/commit-early-push-often/">early and often</a>. If we haven't heard from you in over a week and someone else expresses interest in that issue, we may approve work by the new person.</p>
<h3 id="proposing-a-new-issue">Proposing a new issue</h3><p>If you want to work on something that there is no GitHub issue for, then propose the change in <a href="/community">one of our community forums</a> or 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.</p>
<p>If the project has a roadmap documented in the README, checking the roadmap to see if the feature is already in our pipeline would be a good first step.</p>
<p>When in doubt, ask a question on <a href="/community">one of our community forums</a>.</p>
<h2 id="new-projects">New projects</h2><p>We are also open to working on or hosting projects that are related to the Creative Commons licenses or general mission. Our <a href="/gsoc-2019/project-ideas">Google Summer of Code project ideas</a> list is a good place to find ideas we'd like implemented. If you're interested in working on one of them, please propose it in one of our <a href="/community">community forums</a> (you don't need to be a student, anyone is welcome to work on those ideas) and work out implementation details with CC staff members before you write any code. If you want to suggest a new project idea, follow the same process.</p>
<p>In general, we'd like any new projects to use Python, WordPress/PHP, and/or JavaScript (our framework of choice is Vue.js) so that our team can help review and maintain the project.</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-9 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>