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
+30-30
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,10 @@ 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.
**Figure out if you need to follow this process.**
18
+
##### Figure out if you need to follow this process.
19
19
20
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
21
@@ -34,19 +34,19 @@ Examples that should follow this process:
34
34
- Adding a new filter to the search results page
35
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.
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
43
44
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.
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
80
81
81
Once your design has been approved, proceed to Step 5.
**Wait for CC staff to resolve dependencies (if applicable).**
86
+
##### Wait for CC staff to resolve dependencies (if applicable).
87
87
88
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.
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
96
97
97
Commit early and often, follow [our pull request and code guidelines](/contributing-code/pr-guidelines/), and write tests!
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
105
106
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.
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