Skip to content

Commit ebf98e4

Browse files
committed
initial webpage with getting started info
0 parents  commit ebf98e4

File tree

3 files changed

+278
-0
lines changed

3 files changed

+278
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Python's Google Summer of Code Site
2+
===================================
3+
4+
For many years, Python has used wiki.python.org to keep track of ideas pages,
5+
FAQs, schedules, and all the plans for our participation in Google Summer of
6+
Code. Unfortunately, editing the wiki isn't easy for everyone: it requires a
7+
separate account, explicit edit permissions, knowledge of somewhat arcane
8+
syntax. As a result, the wiki pages are maintained by a very small group.
9+
Since we had great success with moving the student blog information to
10+
github so people could use pull requests to update it, we're going to try to
11+
do the same with the info pages and see how it works out.
12+

index.html

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Python in Google Summer of Code</title>
5+
<link rel="stylesheet" href="style.css">
6+
</head>
7+
8+
<body>
9+
<!-- Top navigation bar -->
10+
<nav class="fixed-nav-bar">
11+
<div id="menu" class="menu">
12+
<ul class="menu">
13+
<li style="float:left"><a href="index.html">Python in GSoC</a>
14+
<li><a href="#schedule">Deadlines</a></li>
15+
<li><a href="#ideas">Project Ideas</a></li>
16+
<li><a href="#mentors">Mentors</a></li>
17+
<li><a href="#students">Students</a></li>
18+
<li><a href="#gettingstarted">Getting Started</a></li>
19+
<li><a href="#about">About</a></li>
20+
</ul>
21+
</div>
22+
</nav>
23+
24+
<div class="content">
25+
<a name="about" />
26+
<h1>Google Summer of Code 2017 @ the Python Software Foundation</h1>
27+
28+
<p><a href="http://python.org">Python</a> is a popular high-level programming language. It is a general-purpose
29+
language used by scientists, developers, and many others who want to get
30+
things done quickly and effectively.
31+
32+
<p><a href="http://code.google.com/soc/">Google Summer of Code</a> is a global
33+
program that offers post-secondary students an opportunity to be paid for
34+
contributing to an open source project over a three month period. Since 2005,
35+
the Python Software Foundation has served as an "umbrella organization" to a
36+
variety of Python-related projects, as well as sponsoring projects related to
37+
the development of the Python language. It is our intention to apply again
38+
for the 2017 season!
39+
40+
<p>The 2017 PSF GSoC coordinator is TerriOda. (terri on Freenode IRC, terrioda
41+
at gmail.com, but please email gsoc-admins(at)python(dot)org if you wish to
42+
contact an admin. Students should almost always email
43+
gsoc-general(at)python(dot)org.)
44+
45+
<p>The other org admins include James Lopeman (meflin on IRC), Florian Fuchs
46+
(florianf on IRC), Kushal Das (kushal on IRC) and Stephen Turnbull
47+
(yaseppochi on IRC)
48+
49+
<a name="gettingstarted" />
50+
<h2>Getting Started</h2>
51+
52+
<p> Here's 7 things
53+
you can do to get started in free and open source software:
54+
55+
<ol type="1"><li><strong>Choose an
56+
organization to work with.</strong>
57+
<br />See &quot;<a class="https"
58+
href="https://wiki.python.org/moin/SummerOfCode/FrequentlyAskedQuestions#How_do_I_choose_a_project_or_a_sub-org.3F">How
59+
do I choose a project or a sub-org?</a>&quot; if you need help choosing.
60+
Don't forget, you can try working with more than one organization to see
61+
which one suits you best!
62+
63+
<ul>
64+
<li>Experience with *any* open source group will help you prepare for GSoC.
65+
If you decide to write an application for GSoC you'll need to choose from our
66+
list of registered sub-orgs, but you can experiment before you get to the
67+
application stage.</li>
68+
69+
<li>Asking mentors to choose your project for you
70+
typically leaves a bad first impression. At least try to narrow down your
71+
choices a bit on your own!</li>
72+
73+
<li>Look through <a
74+
href="/moin/SummerOfCode/2016#Python_Sub-orgs_and_Project_Ideas">our list of
75+
GSoC 2016 sub-orgs</a> to get a sense of who might participate in 2017. This
76+
page will be updated when we know, with a complete list sometime late in
77+
February.
78+
</li>
79+
80+
</ul>
81+
</li>
82+
83+
<li><strong>Start communicating with the developers.</strong><br />
84+
Join the mailing list, IRC channel, or any other communication channels the
85+
developers use. Listen, get to know the people involved, and ask questions.
86+
87+
<ul>
88+
<li>If you want to make the best
89+
first impression, DO NOT start emails with &quot;Dear Sir.&quot; Python has
90+
many mentors who are female and/or prefer other forms of address. Try
91+
&quot;Dear developers&quot; if you're sending a general email, or use
92+
whatever name they use on their email if you're addressing a specific person.
93+
Culturally speaking, first names or chosen nicknames are fine for most open
94+
source projects. </li>
95+
96+
<li><strong>DO</strong> ask your question in public. Being able
97+
to participate in the open is a signal to developers that you're ready to
98+
participate in open source/free software, so it can improve your chances of
99+
being accepted to GSoC. It also means others can benefit from seeing your
100+
questions and the answers you get.</li>
101+
102+
<li><strong>DON'T</strong> Ask to
103+
ask. Just get right to the point and ask your question without asking if
104+
you're allowed to ask a question first. See <a class="https"
105+
href="https://wiki.python.org/moin/SummerOfCode/FrequentlyAskedQuestions#What_does_.22don.27t_ask_to_ask.22_mean.3F">What
106+
does &quot;don't ask to ask?&quot; mean?</a> for more explanation. </li></ul></li>
107+
108+
<li><strong>Set up your own development environment.</strong>
109+
<br />
110+
This can be a lot of work the first time, so budget time for it, and don't
111+
forget that you're going to want to run the code you've written, so you'll
112+
need some sort of test environment. This is a good time to practice asking
113+
good questions and helping improve setup instructions! </li>
114+
115+
<li><strong>Find some bugs and try to fix
116+
them.</strong>
117+
<br />Many projects have bugs tagged as &quot;easy&quot;,
118+
&quot;bite-size&quot;, or &quot;beginner-friendly&quot; that will be easier
119+
for new contributors. <ul><li>Note that if you apply as a student with the
120+
PSF you will be asked to submit a code sample, generally code related to your
121+
project. A few fixed bugs with code accepted upstream will make your
122+
application look great! </li>
123+
124+
<li>Some projects
125+
have beginner-friendly &quot;bite-sized&quot; bugs listed in the OpenHatch
126+
search engine, found here: <a class="http"
127+
href="http://openhatch.org/search/">http://openhatch.org/search/</a> but many
128+
do not, so try searching for tags like "easy" or "beginner" in your project's
129+
bug tree. Remember, competition for easy bugs is very high during GSoC so
130+
it can be hard to find one that's flagged. If you don't see anything, read
131+
through the bugs and choose a few that sound like something you can fix.</li>
132+
133+
<li>Having trouble figuring out which
134+
bugs are beginner-friendly? Try searching for terms like &quot;easy&quot; in
135+
the bug tracker. Or just choose a bug that sounds easy to you and try to get
136+
started on it! What's easy for you may not be easy for others, so take
137+
advantage of your own skills and experience where you can. Remember to ask
138+
for help if you get stuck for too long, &quot;I'm a new contributor and was
139+
trying to work on bug#123456. I have a question about how to...&quot; -- if
140+
people can't help, sometimes they will be able to suggest another bug which
141+
would be more beginner-suitable. </li>
142+
143+
<li>Other &quot;easy&quot; bug ideas: look for typos
144+
and fix them. Set up new tests -- even if your project decides they don't
145+
need the first one you write, the practice of writing test cases will be
146+
useful for other development (e.g. when you want to add a new feature and
147+
need to include tests for it). Try using a tool like pylint to find style
148+
issues and correct those. (But pay attention to your project's style guide!
149+
Not everyone cares about the same things.) </li></ul></li>
150+
151+
<li><strong>Find bugs and report them.</strong>
152+
<br />It's always a
153+
good idea to get familiar with your project's bug reporting process. Writing
154+
excellent bug reports is a really useful skill, so try googling &quot;<a
155+
class="https"
156+
href="https://www.google.com/search?q=writing+good+bug+reports&amp;ie=utf-8&amp;oe=utf-8">writing
157+
good bug reports</a>&quot; and learn to write really great ones. You might
158+
even be able to help improve other people's bug reports by duplicating their
159+
results and asking questions to fill in information they didn't provide.
160+
</li>
161+
162+
<li><strong>Help with documentation.</strong>
163+
<br /> As a beginner in your project,
164+
you're going to see things that are confusing that more experienced
165+
developers may not notice. Take advantage of your beginner mindset and make
166+
sure to document anything you think is missing! </li>
167+
168+
<li><strong>Help others.</strong>
169+
<br /> This is a great idea for many reasons: explaining things can
170+
help you learn them better, demonstrating your skills as a good community
171+
member can make you more memorable when your mentors have to choose
172+
candidates, and being helpful makes your community a better place! </li>
173+
</ol>
174+
175+
176+
<a name="students" />
177+
<h2>Students</h2>
178+
to be filled out
179+
180+
<a name="mentors" />
181+
<h2>Mentors</h2>
182+
to be filled out
183+
184+
<a name="ideas" />
185+
<h2>Project Ideas</h2>
186+
187+
<p>This section will contain information about sub-orgs and their project
188+
ideas once they have gotten in touch with the PSF. If you're unsure whether
189+
your favourite Python-based project will be participating, ask them and
190+
encourage them to sign up!</p>
191+
192+
<p>Note that some of these groups may have applied as separate mentoring
193+
organizations. We're listing everyone who wants to be listed here to help
194+
students find great Python projects, and we'll separate out the listing to
195+
make it clear which ones are under our umbrella and which are participating
196+
on their own after Google makes their selections. </p>
197+
198+
<a name="schedule" />
199+
<h2>Schedule</h2>
200+
to be filled out
201+
202+
</div>
203+
</body>
204+
</html>

style.css

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
.fixed-nav-bar {
2+
position: fixed;
3+
top: 0;
4+
left: 0;
5+
z-index: 8888;
6+
width: 100%;
7+
height: 50px;
8+
background-color: #f0f0f0;
9+
border-bottom: 4px solid #2955a3;
10+
}
11+
.content {
12+
margin-top: 60px;
13+
}
14+
15+
.sitename {
16+
display: inline-block;
17+
margin-right: 20px;
18+
margin-left: 10px;
19+
}
20+
a.sitename, a:visited.sitename {
21+
color: #f0f0f0;
22+
}
23+
24+
.menu ul {
25+
list-style-type: none;
26+
margin: 0;
27+
padding: 0;
28+
overflow: hidden;
29+
height: 50px;
30+
}
31+
32+
.menu li a {
33+
display: block;
34+
margin: 0;
35+
padding: 8px 16px;
36+
height: 50px;
37+
text-decoration: none;
38+
color: #2955a3;
39+
}
40+
.menu li {
41+
display: inline;
42+
float: right;
43+
height: 50px;
44+
margin: 0;
45+
font-size: 1.5em;
46+
}
47+
48+
.menu li a:hover {
49+
background-color: #ffb100;
50+
color: white;
51+
height: 50px;
52+
margin: 0;
53+
}
54+
55+
h1 {
56+
font-size: 1.2em;
57+
}
58+
h2 {
59+
}
60+
61+
li {
62+
padding-bottom: .5em;

0 commit comments

Comments
 (0)