Skip to content

Commit cb8104d

Browse files
authored
Merge branch 'master' into dependabot/npm_and_yarn/webpack/ini-1.3.7
2 parents 97feeab + 97978a6 commit cb8104d

File tree

24 files changed

+725
-343
lines changed

24 files changed

+725
-343
lines changed

.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
# These users own any files in the specified directory and
77
# any of its subdirectories.
88
/webpack/ @creativecommons/frontend-engineers
9+
* @creativecommons/ct-cc-open-source-maintainers

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ venv
99
lektor/admin/static/gen
1010
assets/static/gen
1111

12+
.idea/
13+
.vscode/
14+
1215
node_modules
1316
gui/build
1417
gui/node_modules
+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/)

content/blog/authors/aldenpage/contents.lr

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ name: Alden Page
55
md5_hashed_email: 32853a2ab283e0093bf088d8af5d3cdc
66
---
77
about:
8-
[Alden](https://creativecommons.org/author/aldencreativecommons-org/) is Backend Software Engineer at Creative Commons. He is `@aldenpage` on the CC Slack.
8+
Alden was previously Backend Software Engineer at Creative Commons.
9+
10+
Prior to joining Creative Commons, Alden developed and operated a real-time market risk management system used by equity derivatives traders at Deutsche Bank. He also has experience working in the ad-tech industry and contributing to free software. Alden currently lives in New York City, where he spends much of his time cycling.

content/blog/authors/brenoferreira/contents.lr

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@ name: Breno Ferreira
55
md5_hashed_email: c23cf5bf54e6df322a3b17d176b76320
66
---
77
about:
8-
[Breno](https://creativecommons.org/author/brenoferreira/) was previously Front End Engineer at Creative Commons.
8+
Breno was previously Front End Engineer at Creative Commons.
9+
10+
Breno has 10 years of experience in software development working in various industries, from investment banking to oil engineering, to payment systems.
11+
12+
Outside work, Breno spends his time in Rio de Janeiro, Brazil, where he enjoys running, eating açaí, and paying an occasional visit to the beach. Breno can sometimes be spotted in other corners of the globe on his travels.

content/blog/authors/dhruvkb/contents.lr

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ md5_hashed_email: 0eab64adad056cff2492e7c407a9aa21
66
---
77
about:
88

9-
[Dhruv Bhanushali](https://dhruvkb.github.io/) is the Open Source Community Coordinator at Creative Commons. He goes by `@dhruvkb` on the CC Community Slack workspace. Dhruv developed [CC Vocabulary](https://opensource.creativecommons.org/cc-vocabulary/) as part of [Google Summer of Code 2019](/gsoc-2019/) and now is a maintainer for the project.
9+
[Dhruv Bhanushali](https://dhruvkb.github.io/) was previously Open Source Community Coordinator at Creative Commons. He goes by `@dhruvkb` on the CC Community Slack workspace. Dhruv developed [CC Vocabulary](https://opensource.creativecommons.org/cc-vocabulary/) as part of [Google Summer of Code 2019](/gsoc-2019/) and now is a maintainer for the project.

content/blog/authors/hugosolar/contents.lr

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ name: Hugo Solar
55
md5_hashed_email: 34ed7629f6d0276faf18f8e9da3613b9
66
---
77
about:
8-
[Hugo](https://creativecommons.org/author/hugocreativecommons-org/) is the Web Developer at Creative Commons. He's `@hugo` on Slack.
8+
Hugo was previously Web Developer at Creative Commons.
9+
10+
Hugo brings more than 10 years of experience as a web developer. He spent the last four years as a full stack developer and interface designer, working with local NGOs and institutions supporting social movements and labor unions. He lives in a quiet and small town in Chile with his lovely son; cooking, drinking coffee, and taking care of his orchard. In his free time, he likes to achieve a zen-like state by practicing Karate and Kickboxing.

content/blog/authors/kgodey/contents.lr

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@ name: Kriti Godey
55
md5_hashed_email: 078347dbae1783ecf5e18c29b958d176
66
---
77
about:
8-
[Kriti](https://creativecommons.org/author/kriticreativecommons-org/) is Director of Engineering at Creative Commons. She's `kgodey` on Freenode (IRC) and `@kriti` on the CC Slack.
8+
Kriti was Director of Engineering at Creative Commons from Nov 2018 to Dec 2020.
9+
10+
Kriti shipped her first website when she was ten years old and has been coding ever since. Prior to joining CC, she focused on leading happy and productive distributed engineering teams at startups, and has enjoyed architecting and building both consumer-facing and enterprise software.
11+
12+
Kriti grew up in southern India and moved to the U.S. to attend Oberlin College, where she majored in computer science and mathematics. She is now a proud American citizen, and lives in Oberlin with her husband and 13 overflowing bookcases.

content/blog/authors/mathemancer/contents.lr

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@ name: Brent Moran
55
md5_hashed_email: e56fda401562f168817134ee8cccdf97
66
---
77
about:
8-
[Brent](https://creativecommons.org/author/brent-moran/) is the Senior Data Engineer at Creative Commons. He's `mathemancer` on Freenode (IRC) and `@Brent Moran` on the CC Slack.
8+
Brent was previously the Senior Data Engineer at Creative Commons.
9+
10+
Raised on a Christmas tree farm in central Missouri, Brent's previous experience includes farm work, playing music, writing music, driving a taxi, acting in plays, building sprinkler systems, plowing snow, reading math papers, writing math papers, and algorithmic pricing. He currently lives on the western edge of Germany with his wife, where he enjoys riding his bike in the forest, bouldering, and programming.
11+
12+
Brent's experience in both music and mathematics demonstrates to him that collaboration on creative work and sharing the results with others have compounding rewards over time. He believes that the modern internet is one of the most powerful tools available for collaboration on, and sharing of, creative output. He hopes, therefore, that his work at Creative Commons helps remove barriers to the free flow of content on the internet, thereby enhancing this most useful tool in some small way.

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)