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
Copy file name to clipboardExpand all lines: content/contributing-code/cc-search/contents.lr
+21-11
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
_model: page
2
2
---
3
-
_template: page-with-toc.html
3
+
_template: cc-search-guide.html
4
4
---
5
5
title: Building a New Feature in CC Search
6
6
---
@@ -12,7 +12,8 @@ We also want to enable you - our community members - to build features that woul
12
12
13
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
14
15
-
### Step 0: Evaluate Process
15
+
<h4class="b-header has-text-grey">Step 0</h4>
16
+
### Evaluate Process
16
17
17
18
**Figure out if you need to follow this process.**
18
19
@@ -33,15 +34,17 @@ Examples that should follow this process:
33
34
- Adding a new filter to the search results page
34
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.
35
36
36
-
### Step 1: GitHub Issue
37
+
<h4class="b-header has-text-grey">Step 1</h4>
38
+
### GitHub Issue
37
39
38
40
**Describe the feature on GitHub.**
39
41
40
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.
41
43
42
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.
43
45
44
-
### Step 2: CC Response
46
+
<h4class="b-header has-text-grey">Step 2</h4>
47
+
### CC Response
45
48
46
49
**Wait for a CC staff member to respond.**
47
50
@@ -55,7 +58,8 @@ If at any time it has been more than five business days and you haven't received
55
58
56
59
Once your feature has been preliminarily approved, proceed to Step 3.
57
60
58
-
### Step 3: Planning
61
+
<h4class="b-header has-text-grey">Step 3</h4>
62
+
### Planning
59
63
60
64
**Plan your work.**
61
65
@@ -67,43 +71,49 @@ Once your implementation plan is ready, update the GitHub issue and wait for a s
67
71
68
72
Once your plan has been approved, proceed to the next applicable step.
69
73
70
-
### Step 4: Design
74
+
<h4class="b-header has-text-grey">Step 4</h4>
75
+
### Design
71
76
72
77
**Get Design and UX approved (if applicable).**
73
78
74
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.
75
80
76
81
Once your design has been approved, proceed to Step 5.
77
82
78
-
### Step 5: Dependencies
83
+
<h4class="b-header has-text-grey">Step 5</h4>
84
+
### Dependencies
79
85
80
86
**Wait for CC staff to resolve dependencies (if applicable).**
81
87
82
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.
83
89
84
-
### Step 6: Code
90
+
<h4class="b-header has-text-grey">Step 6</h4>
91
+
### Code
85
92
86
93
**Write your code.**
87
94
88
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!
89
96
90
97
Commit early and often, follow [our pull request and code guidelines](/contributing-code/pr-guidelines/), and write tests!
91
98
92
-
### Step 7: Code Review
99
+
<h4class="b-header has-text-grey">Step 7</h4>
100
+
### Code Review
93
101
94
102
**Get feedback via code review.**
95
103
96
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.
97
105
98
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.
99
107
100
-
### Step 8: Staging
108
+
<h4class="b-header has-text-grey">Step 8</h4>
109
+
### Staging
101
110
102
111
**Get feedback via live testing.**
103
112
104
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.
0 commit comments