Skip to content

Commit 57af363

Browse files
committed
Merge branch 'master' of https://github.com/creativecommons/creativecommons.github.io-source into engagement_guide
2 parents 30906a0 + a9f15d9 commit 57af363

File tree

25 files changed

+449
-142
lines changed

25 files changed

+449
-142
lines changed
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_model: page
2+
---
3+
_template: search_roadmap.html
4+
---
5+
title: [Archived] CC Search
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
_model: page
2+
---
3+
_template: cc-search-guide.html
4+
---
5+
title: [Archived] Building a New Feature in CC Search
6+
---
7+
body:
8+
9+
CC Search is an open source project and we welcome community involvement. Our [active sprint](https://github.com/orgs/creativecommons/projects/7), and [backlog](https://github.com/orgs/creativecommons/projects/10) are public and we maintain a set of GitHub issues that we could use help with.
10+
11+
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.
12+
13+
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.
14+
15+
#### Step 0
16+
## Evaluate Process
17+
18+
##### Figure out if you need to follow this process.
19+
20+
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 [our much simpler guidelines for contributing code](/contributing-code/). If you're not sure what category your proposed change falls under, ask us on GitHub or via [our chat/mailing list](/community/).
21+
22+
Examples that _**do not**_ need to follow this process:
23+
24+
- Any issue marked "help wanted".
25+
- Improving the user experience or fixing bugs related to existing features ([example 1](https://github.com/creativecommons/cccatalog-frontend/issues/141), [example 2](https://github.com/creativecommons/cccatalog-frontend/issues/184))
26+
- **Reasoning**: It does not change the user experience in any significant way and does not require approval.
27+
- Adding automated tests to the code
28+
- **Reasoning**: It is not a user facing change and does not remove or change existing functionality.
29+
30+
Examples that should follow this process:
31+
32+
- Adding a new content type (such as audio files) to CC Search
33+
- **Reasoning**: It changes the fundamental structure of CC Search and requires significant product input and infrastructural work from CC staff.
34+
- Adding a new filter to the search results page
35+
- **Reasoning**: 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.
36+
37+
#### Step 1
38+
## GitHub Issue
39+
40+
##### Describe the feature on GitHub.
41+
42+
Look through [our issues](https://github.com/creativecommons/cccatalog-frontend/issues) to see if there is already a GitHub issue describing the feature you want to build. If none exists, create one on the [cccatalog-frontend](https://github.com/creativecommons/cccatalog-frontend/issues) repository (which holds the code for CC Search) using the "Feature request" template.
43+
44+
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.
45+
46+
#### Step 2
47+
## CC Response
48+
49+
##### Wait for a CC staff member to respond.
50+
51+
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:
52+
53+
- Ask for more information
54+
- Preliminarily approve the feature
55+
- Reject the feature with an explanation and close the issue
56+
57+
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 [contact us elsewhere](/community/). 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.
58+
59+
Once your feature has been preliminarily approved, proceed to Step 3.
60+
61+
#### Step 3
62+
## Planning
63+
64+
##### Plan your work.
65+
66+
Create an implementation plan with the list of changes you'll need to make to implement your feature.
67+
68+
Keep in mind that CC Search heavily depends on the CC Catalog API ([docs](https://api.creativecommons.engineering/), [code](https://github.com/creativecommons/cccatalog-api)) and the CC Catalog data ([code](https://github.com/creativecommons/cccatalog)). 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.
69+
70+
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.
71+
72+
Once your plan has been approved, proceed to the next applicable step.
73+
74+
#### Step 4
75+
## Design
76+
77+
##### Get Design and UX approved (if applicable).
78+
79+
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.
80+
81+
Once your design has been approved, proceed to Step 5.
82+
83+
#### Step 5
84+
## Dependencies
85+
86+
##### Wait for CC staff to resolve dependencies (if applicable).
87+
88+
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.
89+
90+
#### Step 6
91+
## Code
92+
93+
##### Write your code.
94+
95+
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!
96+
97+
Commit early and often, follow [our pull request and code guidelines](/contributing-code/pr-guidelines/), and write tests!
98+
99+
#### Step 7
100+
## Code Review
101+
102+
##### Get feedback via code review.
103+
104+
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.
105+
106+
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.
107+
108+
#### Step 8
109+
## Staging
110+
111+
##### Get feedback via live testing.
112+
113+
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.
114+
115+
#### Step 9
116+
## Production
117+
118+
##### The feature is live!
119+
120+
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!

content/archives/contents.lr

+1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ body:
88

99
The following sections are archives related to older Creative Commons (CC) projects and communications.
1010

11+
- [CC Search (2019-2020)](/archives/cc-search/)
1112
- [CC Tech Blog (2007-2014)](/archives/old-tech-blog/entries/)
1213
- [CC-Devel Mailing List (2005-2015)](https://lists.ibiblio.org/pipermail/cc-devel/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
title: Upcoming Changes to the CC Open Source Community
2+
---
3+
categories:
4+
announcements
5+
cc-browser-extension
6+
cc-catalog
7+
cc-catalog-api
8+
cc-chooser
9+
cc-dataviz
10+
cc-legal-database
11+
cc-link-checker
12+
cc-search
13+
cc-vocabulary
14+
cc-wp-base-theme
15+
cc-wp-plugin
16+
collaboration
17+
community
18+
gsoc
19+
gsod
20+
outreachy
21+
platform-toolkit
22+
wordpress
23+
---
24+
author: kgodey
25+
---
26+
pub_date: 2020-12-07
27+
---
28+
body:
29+
Creative Commons (CC) is adopting a brand new organizational strategy in 2021, just in time for our 20th anniversary. As part of the organization's evolution in alignment with the new strategy, [Alden Page](https://opensource.creativecommons.org/blog/authors/aldenpage/), [Brent Moran](https://opensource.creativecommons.org/blog/authors/mathemancer/), [Hugo Solar](https://opensource.creativecommons.org/blog/authors/hugosolar/), and I ([Kriti Godey](https://opensource.creativecommons.org/blog/authors/kgodey/)) will have departed Creative Commons by the end of December. Moving forward, the CC staff engineering team of [Timid Robot Zehta](https://opensource.creativecommons.org/blog/authors/TimidRobot/) and [Zack Krida](https://opensource.creativecommons.org/blog/authors/zackkrida/) will focus on supporting a smaller set of core projects.
30+
31+
We are extremely proud of the work we have done together to build CC's vibrant open source community over the past two years. And of course, we're thankful for all the amazing contributions that all our community members have made. We've made significant improvements to existing tools, and launched entirely new projects with your help. [We created Vocabulary,](https://opensource.creativecommons.org/blog/categories/cc-vocabulary/) a design system for Creative Commons and launched half a dozen sites using it. We added [dozens of new sources to CC Search](https://opensource.creativecommons.org/blog/categories/cc-catalog/) and improved [its accessibility](https://opensource.creativecommons.org/blog/authors/AyanChoudhary/). We released tools such as the [CC WordPress plugin](https://opensource.creativecommons.org/blog/authors/ahmadbilaldev/) and [CC Search browser extension](https://opensource.creativecommons.org/blog/authors/makkoncept/) that integrated CC licensing with widely used software. And, there's so much more.
32+
33+
### Community Changes
34+
35+
The CC Open Source community remains central to our engineering work, and we will continue to support you in every way we can. However, based on the new staff capacity, we will be making a few changes to our community processes:
36+
37+
- Community Team members will no longer have access to CC's Asana. Most tasks are tracked on GitHub, and managing Asana adds unnecessary complexity to the community team.
38+
- We will invite all Community Team members to meetings and documents open to the community, regardless of role.
39+
- We will deprecate the "community-team-core" mailing list in favor of a single "community-team" mailing list.
40+
- We will have a new monthly Open Source Community meeting and cancel the existing biweekly Engineering Meeting.
41+
- We will no longer have a paid Open Source Community Coordinator, [relying instead on volunteers](https://opensource.creativecommons.org/community/community-team/community-building-roles/) to help assist new community members, maintain our Twitter account, etc.
42+
43+
We welcome new Community Team members and we will continue to participate in internship programs such as Google Summer of Code.
44+
45+
### Project Changes
46+
47+
With a smaller engineering team, we will need to support fewer projects. Please see below for the current status of all projects with at least one Community Team member.
48+
49+
**Active Development**
50+
51+
We will continue to actively develop the following projects:
52+
53+
- [CC Search Browser Extension](https://github.com/creativecommons/ccsearch-browser-extension) (maintainer: Mayank Nader)
54+
- [CC Open Source website](https://github.com/creativecommons/creativecommons.github.io-source) (maintainers: Zack Krida & Timid Robot Zehta)
55+
- [CC WordPress base](https://github.com/creativecommons/creativecommons-base) & child themes (new maintainer: Zack Krida)
56+
- [CC Legal Database](https://github.com/creativecommons/legaldb) (maintainer: Timid Robot Zehta)
57+
- [CC Chooser](https://github.com/creativecommons/chooser) (maintainer: Zack Krida)
58+
- [CC Link Checker](https://github.com/creativecommons/cc-link-checker/) (maintainer: Timid Robot Zehta)
59+
- [License Buttons](https://github.com/creativecommons/licensebuttons/) (maintainer: Timid Robot Zehta)
60+
- [Platform Toolkit](https://github.com/creativecommons/mp/) (maintainer: Timid Robot Zehta)
61+
- [Vocabulary](https://github.com/creativecommons/vocabulary) (maintainers: Zack Krida & Dhruv Bhanushali)
62+
- [WordPress Plugin](https://github.com/creativecommons/wp-plugin-creativecommons) (new maintainer: Zack Krida)
63+
64+
**Maintenance Mode**
65+
66+
The following projects are entering maintenance mode. The services will remain online, but we will not accept any new pull requests or deploy new code after Dec 15, 2020.
67+
68+
- [CC Catalog](https://github.com/creativecommons/cccatalog)
69+
- [CC Catalog API](https://github.com/creativecommons/cccatalog-api)
70+
- [CC Search](https://github.com/creativecommons/cccatalog-frontend/)
71+
- [Linked Commons](https://github.com/creativecommons/cccatalog-dataviz/)
72+
73+
Catalog, API, and Linked Commons contributors are encouraged to contribute to our other Python projects such as the [CC Legal Database](https://github.com/creativecommons/legaldb) or the upcoming [CC Licenses](https://github.com/creativecommons/cc-licenses) project. If you are a CC Search contributor, we recommend checking out frontend projects such as the [CC Chooser](https://github.com/creativecommons/chooser) or [Vocabulary](https://github.com/creativecommons/vocabulary).
74+
75+
### Thank You!
76+
77+
We cannot express our gratitude for our community enough. You are all an absolute pleasure to work with, and we're looking forward to continuing to collaborate with you for years to come.

content/cc-search/contents.lr

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
_model: page
1+
_model: redirect
22
---
3-
_template: search_roadmap.html
3+
target: /archives/cc-search/
44
---
5-
title: CC Search
5+
_discoverable: no

0 commit comments

Comments
 (0)