You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Creative Commons team is committed to fostering a welcoming community.
4
-
5
-
**Our Code of Conduct can be found here**: [https://creativecommons.github.io/community/code-of-conduct/](https://creativecommons.github.io/community/code-of-conduct/)
3
+
The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our [Code of Conduct](https://creativecommons.github.io/community/code-of-conduct/). Please report unacceptable behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org) per our [reporting guidelines](https://creativecommons.github.io/community/code-of-conduct/enforcement/).
6
4
7
5
For a history of updates, see the [page history here](https://github.com/creativecommons/creativecommons.github.io-source/commits/master/content/community/code-of-conduct/contents.lr).
Thank you for your interest in contributing to CC Open Source! This document is a set of guidelines to help you contribute to this project.
4
+
5
+
## Code of Conduct
6
+
7
+
By participating in this project, you are expected to uphold our [Code of Conduct](https://creativecommons.github.io/community/code-of-conduct/).
8
+
9
+
## Project Documentation
10
+
11
+
The `README` contains details about how to install and build this project and a high-level overview of the code.
12
+
13
+
## How to Contribute
14
+
15
+
Please follow the processes in our general [Contributing Code](https://creativecommons.github.io/contributing-code/) guidelines on the Creative Common Open Source website.
16
+
17
+
You do not have to follow the steps under "Check for contribution readiness", this project is accepting contributions.
18
+
19
+
## Style Guide
20
+
21
+
- Make sure that there are newlines at the end of every file.
22
+
- We use 2 spaces as the standard indentation in our HTML files.
23
+
24
+
## Questions or Thoughts?
25
+
26
+
Talk to us on [our developer mailing list or Slack community](https://creativecommons.github.io/community/).
Copy file name to clipboardExpand all lines: content/community/contents.lr
+7-1
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
_model: page
2
2
---
3
+
_template: page-with-toc.html
4
+
---
3
5
title: Join the CC Developer Community
4
6
---
5
7
body:
@@ -15,7 +17,7 @@ For information regarding joining a channel on Slack, [look here](https://get.sl
15
17
16
18
Note that channels like `#general` on Slack consist of a fair amount of users. While it is a channel for general-purpose discussions, please take into consideration that a post on such a channel will notify thousands of users. 😄
17
19
18
-
If you're looking to talk to someone on CC's tech team, we are all in the Americas and someone is usually around on Slack between 11:00 and 23:00 UTC on weekdays.
20
+
If you're looking to talk to someone on CC's tech team, we are all in the Americas and someone is usually around on Slack between 11:00 and 23:00 UTC on weekdays. See the [Resources](#resources) section below for best practices for asking technical questions.
19
21
20
22
## Mailing List
21
23
@@ -27,3 +29,7 @@ The archives of our [previous mailing list are here](https://lists.ibiblio.org/p
27
29
We have two channels on [Freenode](https://freenode.net/).
28
30
-`#creativecommons-dev` – for technical discussion
29
31
-`#creativecommons` – for general discussion (this is mirrored to the `#general` channel on Slack, use only if you want to reach 4000+ people)
32
+
33
+
## Resources
34
+
35
+
*[Getting Answers](https://www.mikeash.com/getting_answers.html): A guide to asking good technical questions.
Copy file name to clipboardExpand all lines: content/contributing-code/contents.lr
+32-25
Original file line number
Diff line number
Diff line change
@@ -6,43 +6,51 @@ title: Contributing Code
6
6
---
7
7
body:
8
8
9
-
## Existing projects
9
+
We do all of our development on GitHub and are generally open to pull requests and proposals for new community-maintained projects. We would especially like help with reviving projects that CC's engineering team does not have the time to actively work on (such as [our WordPress plugin](https://github.com/creativecommons/creativecommons-wordpress-plugin) and [license chooser widget](https://github.com/creativecommons/LicenseChooser.js)).
10
10
11
-
Here's a list of [all our current projects](/projects). We do all of our development on GitHub and are generally open to pull requests. We would especially like help with reviving projects that CC's engineering team does not have the time to actively work on (such as [our WordPress plugin](https://github.com/creativecommons/creativecommons-wordpress-plugin) and [license chooser widget](https://github.com/creativecommons/LicenseChooser.js)). We're also looking to improve our documentation and increase our automated test coverage across pretty much all our projects.
11
+
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.
12
12
13
-
We are working on making sure all of our projects are documented, licensed, and have self-contained contribution guidelines. Until we finish that work, follow the guidelines below before writing any code.
13
+
## Working on an existing project
14
14
15
-
### Check for contribution readiness
15
+
Here's a list of [all our current projects](/projects).
16
16
17
-
We do not accept contributions to projects without licenses. We're working on adding licenses to all our repositories but we will prioritize ones in which there is an active interest in contribution. If the repository you want to contribute to has no license file (or is missing other infrastructure such as basic documentation), please create a GitHub issue attached to that repository asking us to set those up.
17
+
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 `LICENSE`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.
18
18
19
-
### Working on open GitHub issues
19
+
You may also create GitHub issues for any other missing infrastructure such as a `README` file.
20
20
21
-
We track all our work via the GitHub issues associated with each repository and they are a good way to find things to work on. The first step is to check the labels on the issue and follow the appropriate steps below.
21
+
### Working on open issues
22
22
23
-
**If the issue is labeled "help wanted" or "good first issue"**, comment on it to indicate that you're working on it (so that no one else does) and submit a pull request when you're ready. No other steps are needed.
24
-
* Here's a list of [all issues labeled "good first issue"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
25
-
* Here's a list of [all issues labeled "help wanted"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
23
+
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:
24
+
* Issues labeled **"in progress"** are generally not available, but may be available if there has been no activity on the issue or related PR for over a week.
25
+
* Issues labeled **"help wanted"** or **"good first issue"** have been identified as available for community contribution.
26
+
* Here's a list of [all issues labeled "good first issue"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
27
+
* Here's a list of [all issues labeled "help wanted"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
28
+
* If the issue does not have either of those labels, it may still be open for contribution.
26
29
27
-
**If it does not have either of those labels**, comment on it to ask if help is desired. If you receive a response that tells you to go ahead and work on it, comment on it to indicate that you're working on it (so that no one else does) and submit a pull request when you're ready.
30
+
Once you have identified an issue you'd like to work on, follow these steps:
28
31
29
-
### Proposing something new
32
+
1. Comment on it and say you'd like to work on that issue.
33
+
2. 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.
34
+
3. Once the issue has been updated to "in progress", write your code and submit your pull request (be sure to read and follow the **[Pull request guidelines](#pull-request-guidelines)** guide below!)
35
+
4. Wait for code review and address any issues raised as soon as you can.
36
+
37
+
Even if you're not done with the issue, create a [draft pull request](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests) and push your code [early and often](https://www.worklytics.co/blog/commit-early-push-often/). If we haven't heard from you in over a week and someone else expresses interest in that issue, we may assign it to the new person.
38
+
39
+
### Proposing a new issue
30
40
31
41
If you want to work on something that there is no GitHub issue for, then propose the change in [one of our community forums](/community) or create a a new GitHub issue associated with the relevant repository amd propose your change there. Be sure to include implementation details and the rationale for the proposed change.
32
42
33
43
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.
34
44
35
45
When in doubt, ask a question on [one of our community forums](/community).
36
46
37
-
## New projects
38
-
39
-
We are also open to working on or hosting projects that are related to the Creative Commons licenses or general mission. Our [Google Summer of Code project ideas](/gsoc-2019/project-ideas) 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 [community forums](/community) (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.
40
-
41
-
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.
42
-
43
-
## General best practices
47
+
## Pull request guidelines
44
48
45
-
No matter what kind of project you're working on, these are good guidelines to follow
49
+
* Read and follow the contributing guidelines and code of conduct for the project. Here are screenshots of where to find them for [first time contributors](first-time-contributor-resources.png) and [previous contributors](previous-contributor-resources.png).
50
+
* Use the format specified in pull request template for the repository if one exists.
51
+
* Describe your change in detail. Too much detail is better than too little.
52
+
* Describe how you tested your change.
53
+
* If a reviewer is not assigned automatically, manually [request a review](https://help.github.com/en/articles/requesting-a-pull-request-review) from either the repository maintainer (if you have that information) or `@creativecommons/engineering`.
46
54
47
55
### Code
48
56
@@ -52,9 +60,8 @@ No matter what kind of project you're working on, these are good guidelines to f
52
60
* Document your code thoroughly.
53
61
* Make sure all the existing tests pass.
54
62
55
-
### Pull requests
63
+
##New projects
56
64
57
-
* Use the format specified in pull request template for the repository if there is one.
58
-
* Describe your change in detail. Too much detail is better than too little.
59
-
* Describe how you tested your change.
60
-
* Request a review from either the repository maintainer (if you have that information) or `@creativecommons/engineering`.
65
+
We are also open to working on or hosting projects that are related to the Creative Commons licenses or general mission. Our [Google Summer of Code project ideas](/gsoc-2019/project-ideas) 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 [community forums](/community) (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.
66
+
67
+
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.
- Example Open Source link checking software: [wummel/linkchecker: check links in web documents or full websites](https://github.com/wummel/linkchecker) (just an example--not a requirement)
18
+
-[Current list of open issues related to license URL issues](https://github.com/creativecommons/creativecommons.org/issues?q=is%3Aissue+is%3Aopen+label%3A%22License+Link+Translation+or+URL+Problem%22) (these are the kinds of issues we're trying to preempt).
18
19
---
19
20
expected_result:
20
21
Public release of Python software that ingests the license source files and
Copy file name to clipboardExpand all lines: content/gsoc-2019/project-ideas-collection/search-by-use-case/contents.lr
+5-5
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: CC Search: search by use case
6
6
---
7
7
description:
8
8
9
-
Prototype in CC Search a way to search for specific materials to use for specific types of projects e.g. CC music for videos or podcasts.
9
+
Prototype in CC Search a way to search for specific materials to use for specific types of projects. For example: search images for slide presentations (stock photos), for printed and/or digital magazines (which might require high resolution), for educational material (use content from GLAM providers), etc..
10
10
---
11
11
rationale:
12
12
@@ -23,12 +23,12 @@ expected_result:
23
23
24
24
A new feature or set of new features added to CC Search to support searching CC-licensed content for a specific purpose. You can decide what use cases you'd like to focus on.
0 commit comments