Skip to content

Commit 4a20747

Browse files
authored
Merge pull request #244 from numfocus/update-docs
Update repository texts
2 parents dc98d69 + a0917f4 commit 4a20747

12 files changed

+455
-428
lines changed

2017/proposals/skeleton.md

Lines changed: 0 additions & 92 deletions
This file was deleted.

CONTRIBUTING-mentors.md

Lines changed: 59 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,69 @@
1-
# Contributing Guide for Mentors
1+
# Contributing Guide for Mentors and Sub Orgs
2+
## Organizations Eligible Under NumFOCUS Umbrella
23

3-
To be a mentor go to [GSoC homepage][GSoC] and create your profile.
4-
If you need help, please check
5-
http://en.flossmanuals.net/melange/creating-and-editing/.
4+
Organizations either financially supported or affiliated with NumFOCUS can
5+
participate under the NumFOCUS umbrella. The organization must also have:
66

7-
**After creating your profile, open an [issue][issues] requesting that your
8-
username be added at [organization/team.md][OT] or send a pull request with
9-
your addition.**
7+
1. One sub-org admin
8+
and at least two mentors (**the sub-org admin can be one of the mentors**)
9+
who are willing to commit for the full GSoC period.
10+
2. Must be a NumFOCUS sponsored or affiliated project
11+
3. Have a good ideas page (**NumFOCUS Admins will help with that**).
1012

11-
### Proposal summary (Mentors)
13+
The sub org administrator and has the responsibility to communicate with
14+
NumFOCUS and advertise GSoC to the community of their organization.
1215

13-
**Short Version**
16+
You can signup as a participating org with us until the application deadline for
17+
the current year or up to 3 days after Google announces that NumFOCUS is
18+
participating as a umbrella org.
1419

15-
If you have a proposal, please create an [issue][issues] for it.
16-
Please make sure that the project can be partly completed during the summer so that students pass the final evaluation.
17-
See the expectations in the [student guide][CS].
20+
When you sign-up with us you should also tell us your preferred way for students
21+
to contact you and a link to your new contributor page if you have one.
1822

19-
Please also
20-
read the [student guide][CS]
23+
## Sub Org Administrators
2124

22-
**Long Version**
25+
Each project/organization under NumFOCUS umbrella for GSoC should have one
26+
administrator.
2327

24-
If you have a proposal,
28+
The **sub-org admins** are responsible for
29+
30+
- provide a list of projects ideas to **organization administrator**
31+
- advertise the application to the project/organization they represent
32+
- signup mentors with NumFOCUS
33+
- connect users with NumFOCUS profile
34+
- request to **organization administrator** a minimum and a maximum number of
35+
slots
36+
- assign mentors and students to available slots
37+
- ensure evaluations for accepted projects are submitted on time
38+
- Try to have the whole community engage with the students in their project
39+
40+
## Mentors
41+
42+
To be a mentor please tell your sub-org administrator so he can give you all the
43+
information you need to sign up.
44+
45+
## Projects
46+
47+
Please make sure that the project can be partly completed during the summer so
48+
that students pass the final evaluation. Please also read
49+
the [student guide][CS], especially our requirements from students.
50+
51+
To ensure a project can be completed we recommend as a guideline that the
52+
project should be possible to complete by the mentor in about one week of full
53+
time work. This doesn't sound like a lot of time but students generally take
54+
much longer then a long-time developer. They have to get familiar with the code
55+
and have to acquire a huge amount of domain knowledge.
56+
57+
There has to be at least one primary mentor and one backup mentor per project.
58+
This means you should have at least 2 mentors available. A mentor can only be
59+
'primary' for one student but a backup for as many as he likes. The sub org
60+
admin can also be a mentor.
61+
62+
If you have a proposal you can use our [proposal templates][template] and
63+
publish the ideas list here or you can link to an ideas list on one of your own
64+
websites/repositories.
65+
66+
To publish your project ideas here follow this guide.
2567

2668
1. copy `YYYY/ideas/skeleton.md` to `YYYY/ideas/title-of-my-proposal.md`
2769
where `YYYY` is the currently year
@@ -31,7 +73,5 @@ If you have a proposal,
3173
4. [create an issue](https://github.com/numfocus/gsoc/issues/new)
3274
where students can ask questions.
3375

34-
[GSoC]: https://www.google-melange.com/gsoc/homepage/google/gsoc2015
35-
[issues]: https://github.com/numfocus/gsoc/issues
36-
[OT]: organization/team.md
3776
[CS]: CONTRIBUTING-students.md
77+
[template]: templates/ideas-page.md

0 commit comments

Comments
 (0)