Skip to content

Commit 9ca888b

Browse files
authored
Merge pull request creativecommons#664 from creativecommons/outreachy-2022-dec-project-ideas
Outreachy 2022 Dec project ideas
2 parents ecd76d5 + fe4b679 commit 9ca888b

File tree

10 files changed

+292
-35
lines changed

10 files changed

+292
-35
lines changed

content/blog/authors/sara/contents.lr

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
username: sara
2+
---
3+
name: Sara Lovell
4+
---
5+
md5_hashed_email:
6+
---
7+
about:
8+
Sara is the Full-Stack Engineer at [Creative Commons][creativecommons]. She is
9+
`@sara` on [CC Slack](/community/) and [possumbilities][github] on GitHub.
10+
11+
[creativecommons]: https://creativecommons.org/author/saracreativecommons-org/
12+
[github]: https://github.com/possumbilities

content/programs/applicant-guide/contents.lr

+12-12
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ anything like that, please don't hesitate to ask!
5050

5151
[Join the `#cc-dev-workprograms` channel on the CC Slack or the CC Developers
5252
mailing list](/community/) as early as possible to introduce yourself and get
53-
feedback on your ideas. All our mentors will be on Slack and respond to emails
54-
on the mailing list and it is better to post there rather than contacting them
55-
individually. Feel free to ask questions!
53+
feedback on your ideas. All our project leads will be on Slack and respond to
54+
emails on the mailing list and it is better to post there rather than
55+
contacting them individually. Feel free to ask questions!
5656

5757

5858
### Pick a Project
@@ -116,8 +116,8 @@ contribution guidelines (not all of them will have them).
116116

117117
If you're applying via Outreachy, remember to record your contribution via the
118118
Outreachy website! You can record contributions even if you have not yet
119-
received feedback on them or if they have not been mergedour mentors are
120-
busy so we can be slow to provide feedback.
119+
received feedback on them or if they have not been merged--our project leads
120+
are busy so we can be slow to provide feedback.
121121

122122

123123
### Contributing Documentation
@@ -148,10 +148,10 @@ of work here to turn those into a feasible plan and timeline for a complete
148148
project that you can ship during the work program.
149149

150150
**This is not something you should be working on in isolation.** We expect you
151-
to have a lot of questions for the mentors along the way as you try and
151+
to have a lot of questions for the project leads along the way as you try and
152152
understand the project, come up with ideas, evaluate feasibility, etc. We also
153-
expect you to come up with a first draft and get feedback from mentors before
154-
you submit the final application on the program's official site.
153+
expect you to come up with a first draft and get feedback from project leads
154+
before you submit the final application on the program's official site.
155155

156156
We suggest reading some articles on writing good Google Summer of Code
157157
proposals (even if you're applying for Outreachy). Here are some examples:
@@ -165,23 +165,23 @@ proposals (even if you're applying for Outreachy). Here are some examples:
165165
### Template
166166

167167
You must use **[our work program project template][projecttemplate]** to create
168-
your application. Please make sure that your mentors have comment permissions
169-
before you share your document with them.
168+
your application. Please make sure that your project leads have comment
169+
permissions before you share your document with them.
170170

171171
If you are applying for Outreachy, please link to the project proposal document
172172
created using this template from your final Outreachy application.
173173

174174
[projecttemplate]: https://docs.google.com/document/d/18LWuA_iTSGSeRFtpVQdfOoz1G30ZgJg-_K0lNSQBYd0/edit
175175

176176

177-
## Contacting Mentors
177+
## Contacting Project Leads
178178

179179
All the CC project leads are on [Slack](/community/). **Please use public
180180
channels on Slack as the primary method of communication.** Public channels are
181181
better than direct messages because it allows any available project lead (or
182182
even another applicant) to answer your questions and interact with you. It also
183183
allows other applicants who have the same questions to benefit from the answers
184-
the mentor is giving you.
184+
the project lead is giving you.
185185

186186
**Please ask project leads specific questions.** We don't know how to help you
187187
get started unless we know what you have questions about. People come from a

content/programs/contents.lr

+2
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ We will apply for the December 2022 interships.
6363

6464
| Name | Pronouns | Slack Username |
6565
| ---- | -------- | -------------- |
66+
| [Sara][authorsara] | she/her | `@sara` |
6667
| [Timid Robot][authortimidrobot] | they/them | `@Timid Robot` |
6768

69+
[authorsara]: /blog/authors/sara/
6870
[authortimidrobot]: /blog/authors/TimidRobot/

content/programs/lead-guide/contents.lr

+29-20
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,26 @@ page serves as a general project lead guide.
1212
---
1313
body:
1414

15+
1516
## Considerinng Being a Project Lead?
1617

17-
Leading a project or mentorship is a serious commitment but a very rewarding
18-
experience. If you're trying to decide whether to be a project lead, please
19-
read the following documents:
20-
- [Google Summer of Code mentor
21-
guide](https://google.github.io/gsocguides/mentor/)
22-
- Outreachy [mentor role description](https://www.outreachy.org/mentor/#mentor)
23-
and [mentor expectations][outmentorexpect]
24-
- [Outreachy Mentor FAQ](https://www.outreachy.org/mentor/mentor-faq/)
18+
Leading a project is a serious commitment but a very rewarding experience. If
19+
you're trying to decide whether to be a project lead, please read the following
20+
documents:
21+
- Google Summer of Code (GSoC) [mentor guide][gsocmentor]
22+
- Outreachy [mentor role description][outmentorrole], [mentor
23+
expectations][outmentorexpect], and [mentor FAQ][outmentorfaq]
2524

2625
If you'd like to be a project lead but don't have a specific project in mind,
2726
email the [CC Developers mailing list](/community/) and let us know what your
2827
skillset and availability is. We'll see if we have a project you can help out
2928
with. If you'd like to propose a project, read on.
3029

30+
[gsocmentor]: https://google.github.io/gsocguides/mentor/
31+
[outmentorrole]: https://www.outreachy.org/mentor/#mentor
3132
[outmentorexpect]: https://www.outreachy.org/docs/internship/#mentor-expectations
33+
[outmentorfaq]: https://www.outreachy.org/mentor/mentor-faq/
34+
3235

3336
## Proposing a Project
3437

@@ -52,12 +55,13 @@ _**[Project Title]**_
5255
- **Technical Skills**: _What technical skills will this project need?_
5356
- **Difficulty**: _How technically difficult is this project? Options: High,
5457
Medium, Low_
55-
- **Size**: _Large (~350 hours) or Medium (~175 hours)._
58+
- **Size**: _Options: Large (~350 hours) or Medium (~175 hours)._
5659

5760
Please note that project ideas should be related to an existing CC open source
5861
project or website and should be clearly scoped out. They should be doable in
5962
three months by a contributor with very little prior experience.
6063

64+
6165
## Application Period
6266

6367
Once the initial application period opens, things get chaotic for a little bit
@@ -78,6 +82,7 @@ Some tips:
7882
because there are far too many people, so help them help themselves.
7983
- Prepare general documentation/frequently asked questions ahead of time.
8084

85+
8186
### Draft Application
8287

8388
You should encourage applicants to share drafts of the application with you
@@ -87,18 +92,21 @@ understanding of the project, the project plan, timeline, and deliverables
8792
match what you had in mind and is feasible (keeping in mind that they may be
8893
new to all this and may not get things done as quickly).
8994

95+
9096
## Work Program Period
9197

98+
9299
### Preparing
93100

94101
Before the work program period begins:
95-
- Talk to your backup lead/secondary mentor ahead of your time to create a plan
96-
for how to collaborate:
102+
- Talk to your backup lead ahead of your time to create a plan for how to
103+
collaborate:
97104
- Who will be repsonsible for what?
98105
- How will checkins and notes work?
99-
- If your project affects or involves anyone else at CC that's not
100-
leading/mentoring the project, talk to them about how they would like to be
101-
involved and come up with a plan to collaborate.
106+
- If your project affects or involves anyone else at CC that's not leading the
107+
project, talk to them about how they would like to be involved and come up
108+
with a plan to collaborate.
109+
102110

103111
### Post-Announcement
104112

@@ -112,9 +120,9 @@ Once the selected contributors have been announced:
112120
fix these items before any work is actually started.
113121
- have an introductory call with the contributor and get to know each other. ask
114122
them questions about themselves and talk about yourself too.
115-
- set up regular meetings: a weekly video call for the mentors to check-in with
116-
the contributor, and a monthly call with the cc program coordinator to check
117-
in with the contributor.
123+
- set up regular meetings: a weekly video call for the project lead to check-in
124+
with the contributor, and a monthly call with the cc program coordinator to
125+
check in with the contributor.
118126
- create a document to keep any project information and notes. this document
119127
should be shared with the program coordinators.
120128
- the “final” implementation plan and weekly milestones (“final” because it
@@ -140,11 +148,12 @@ Once the selected contributors have been announced:
140148
- ensure that the contributor has permissions to push to the appropriate GitHub
141149
repository.
142150

151+
143152
### During the Work Program
144153

145154
During the work program:
146155
- Attend your weekly check-in.
147-
- Take good notes so that your backup mentor can pick up where you left off
156+
- Take good notes so that your backup lead can pick up where you left off
148157
easily if you’re unavailable.
149158
- Make sure the contributor is on-track with their weekly milestones and if
150159
not, work with them to figure out why and come up with a plan.
@@ -159,7 +168,7 @@ During the work program:
159168
they are often not experienced with the work they are doing and may not know
160169
to ask for help or may be stuck on something that they cannot articulate very
161170
well.
162-
- Ask for feedback on your mentorship every few weeks.
171+
- Ask for feedback as the project lead every few weeks.
163172
- Find an opportunity to invite your contributor to present their work at CC’s
164173
all staff meeting. It is up to you when you’d like to do this.
165174
- Make sure you're familiar with the program timeline and submit your required
@@ -178,4 +187,4 @@ During the work program:
178187
- your contributor is not communicating enough or misses a check-in.
179188
- you have concerns or even just a bad feeling about something.
180189
- you have feedback or questions about any part of the program process.
181-
- you'd like feedback about how your mentoring is going
190+
- you'd like feedback about how your role as project lead is going
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
_model: project-idea
2+
---
3+
_hidden: yes
4+
---
5+
title: Add plain text format to CC Legal Tools
6+
---
7+
problem:
8+
Plain text formats for the 4.0 licenses and the CC0 public domain dedication
9+
were created using a manual process ([Plaintext versions of Creative Commons
10+
licenses and CC0 - Creative Commons][blogplaintext]). Only the English
11+
versions of the legal tools were formatted as plain text. Additionally, that
12+
manual creation process was not without errors and is not sustainable.
13+
14+
[blogplaintext]: https://creativecommons.org/2011/04/15/plaintext-versions-of-creative-commons-licenses-and-cc0/
15+
---
16+
expected_outcome:
17+
Extend the CC Legal Tools App to generate deterministic plain text versions of
18+
the 4.0 licenses and the CC0 public domain dedication.
19+
---
20+
contributor_tasks:
21+
The contributor will need to extend the CC Legal Tools App to generate plain
22+
text versions. The generated plain text versions must be deterministic and
23+
match the formatting of the manual versions (except where improvements are
24+
desired). Application updates must include test coverage. Stretch goals include
25+
Markdown format generation and interfacing/collaborating with SPDX.
26+
---
27+
application_tips:
28+
- Engage with the CC Legal Tools repositories (issues, pull requests)
29+
- Be helpful and welcoming (e.g. answer other contributors’ questions on Slack)
30+
- [Applicant Guide](/programs/applicant-guide/)
31+
---
32+
resources:
33+
- [creativecommons/cc-legal-tools-app][cc-legal-tools-app]: License and public
34+
domain dedication management application for Creative Commons
35+
- [creativecommons/cc-legal-tools-data][cc-legal-tools-data]: License and
36+
public domain dedication data for Creative Commons
37+
- [Plaintext versions of Creative Commons licenses and CC0 - Creative
38+
Commons][blogplaintext]
39+
40+
[cc-legal-tools-app]: https://github.com/creativecommons/cc-legal-tools-app
41+
[cc-legal-tools-data]: https://github.com/creativecommons/cc-legal-tools-data
42+
[blogplaintext]: https://creativecommons.org/2011/04/15/plaintext-versions-of-creative-commons-licenses-and-cc0/
43+
---
44+
skills_recommended:
45+
- Djano
46+
- Git
47+
- Python
48+
---
49+
lead:
50+
- Timid Robot
51+
---
52+
difficulty: Medium
53+
---
54+
size: Large (~350 hours)
55+
---
56+
filter_value: difficulty-medium skill-django skill-git skill-python
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
_model: project-idea
2+
---
3+
_hidden: yes
4+
---
5+
title: Add RDF XML format to CC Legal Tools
6+
---
7+
problem:
8+
The CC Legal Tools App is currently using legacy RDF files for the machine
9+
readable layer of the legal tools. Those files are out of date and contain a
10+
few errors and omissions. This technical debt also prevents future work to
11+
improve the machine readable layer of the CC Legal Tools.
12+
---
13+
expected_outcome:
14+
Extend the CC Legal Tools App to generate deterministic RDF XML files for all
15+
of the legal tools.
16+
---
17+
contributor_tasks:
18+
The contributor will need to extend the CC Legal Tools App to generate RDF XML
19+
files. The generated RDF XML files must be deterministic and well organized and
20+
based on current RDF specifications. Application updates must include test
21+
coverage. Stretch goals include planning any breaking changes and working on a
22+
static API.
23+
---
24+
application_tips:
25+
- Engage with the CC Legal Tools repositories (issues, pull requests)
26+
- Be helpful and welcoming (e.g. answer other contributors’ questions on Slack)
27+
- [Applicant Guide](/programs/applicant-guide/)
28+
---
29+
resources:
30+
- [creativecommons/cc-legal-tools-app][cc-legal-tools-app]: License and public
31+
domain dedication management application for Creative Commons
32+
- [creativecommons/cc-legal-tools-data][cc-legal-tools-data]: License and
33+
public domain dedication data for Creative Commons
34+
- [Describing Copyright in RDF - Creative Commons Rights Expression Language][describerdf]
35+
36+
[cc-legal-tools-app]: https://github.com/creativecommons/cc-legal-tools-app
37+
[cc-legal-tools-data]: https://github.com/creativecommons/cc-legal-tools-data
38+
[describerdf]: https://creativecommons.org/ns/
39+
---
40+
skills_recommended:
41+
- Djano
42+
- Git
43+
- Python
44+
- RDF
45+
- XML
46+
---
47+
lead:
48+
- Timid Robot
49+
---
50+
difficulty: High
51+
---
52+
size: Large (~350 hours)
53+
---
54+
filter_value: difficulty-high skill-django skill-git skill-python skill-rdf skill-xml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
_model: project-idea
2+
---
3+
_hidden: yes
4+
---
5+
title: Modernize termination-of-transfer WordPress plugin
6+
---
7+
problem:
8+
Due to its current setup and structure it is difficult to install from the
9+
codebase directly into a WordPress installation (i.e. via Composer).
10+
Additionally, the codebase has sections that need to be checked and updated to
11+
current coding standards and best practices.
12+
---
13+
expected_outcome:
14+
The plugin’s structure and setup follows current development standards, increasing maintainability and ease-of-use.
15+
---
16+
contributor_tasks:
17+
The contributor will restructure the repo, adjusting any necessary code to meet
18+
current WordPress plugin development standards, and best practices for PHP and
19+
Javascript (follow appropriate ECMAScript standards), while creating a
20+
directory structure that allows the codebase to be deployed into a standard
21+
WordPress installation.
22+
---
23+
application_tips:
24+
- Engage with the CC Legal Tools repositories (issues, pull requests)
25+
- Be helpful and welcoming (e.g. answer other contributors’ questions on Slack)
26+
- [Applicant Guide](/programs/applicant-guide/)
27+
---
28+
resources:
29+
- [creativecommons/termination-of-transfer][termination-of-transfer]
30+
- [[Feature] Convert repository / codebase to a WordPress plugin that can be
31+
installed via composer #127][issue127]
32+
- [Introduction to Plugin Development][wp-plugin-dev]
33+
- [MDN Web Docs: ECMAScript Standards][mdm-ecma-standards]
34+
- [PHP-FIG: PSR-1][psr1]
35+
36+
[termination-of-transfer]: https://github.com/creativecommons/termination-of-transfer
37+
[issue127]: https://github.com/creativecommons/termination-of-transfer/issues/127
38+
[wp-plugin-dev]: https://developer.wordpress.org/plugins/intro/
39+
[mdm-ecma-standards]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/JavaScript_technologies_overview#standardization_process
40+
[psr1]: https://www.php-fig.org/psr/psr-1/
41+
---
42+
skills_recommended:
43+
- Git
44+
- JavaScript
45+
- PHP
46+
- WordPress
47+
---
48+
lead:
49+
- Sara
50+
---
51+
difficulty: Medium
52+
---
53+
size: Large (~350 hours)
54+
---
55+
filter_value: difficulty-medium skill-git skill-javascript skill-php skill-wordpress

0 commit comments

Comments
 (0)