Skip to content

Commit 4fea84f

Browse files
authored
Add project lead and contributor guides (#2)
1 parent 0547d41 commit 4fea84f

File tree

4 files changed

+125
-9
lines changed

4 files changed

+125
-9
lines changed

_includes/guides.html

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<section id="leads">
2+
<div class="container">
3+
<div class="row">
4+
<div class="col-sm-8 col-sm-offset-2 text-center">
5+
<i class="fa fa-4x fa-lightbulb-o wow bounceIn text-primary"></i>
6+
<h2 class="section-heading">Protips for project leads</h2>
7+
<hr class="primary">
8+
<h3 class="text-left">How to become one</h3>
9+
<p class="text-left">
10+
You do not need to be the owner of an open-source project to be accepted as a project lead. However, you must contribute regularly and be knowledgeable about the entire codebase.
11+
If you meet these criteria, simply contact one of the organizers listed in the event page.
12+
</p>
13+
<h3 class="text-left">Before the event starts</h3>
14+
<p class="text-left">
15+
Promote the event and your project to attract contributors!<br/>
16+
One way to do that is to prepare a small video or standalone slideshow to explain:
17+
</p>
18+
<ul class="text-left">
19+
<li>what your project is about</li>
20+
<li>the kind of contributions you are looking for</li>
21+
<li>any prerequisites</li>
22+
</ul>
23+
<p class="text-left">
24+
Here is an excellent example of a <a href="https://drive.google.com/file/d/1tPkAYkBFjy4O1Zr3qWQv2k9GKU9tkBXb/view" rel="noopener" target="_blank">short video introduction</a> of the Kubernetes documentation translation project.
25+
</p>
26+
<p class="text-left">
27+
hack-commit-push events aim at being inclusive.
28+
This means you will likely collaborate with people of heterogeneous experience.
29+
We advise you to prepare a backlog of issues of varying difficulty.
30+
If your project requires some prior knowledge that would take too long to explain during the event, be very explicit about it in your presentation.
31+
</p>
32+
<p class="text-left">
33+
If the event is virtual, make sure to be available at some point to get familiar with the tooling.
34+
If the event happens in a centralized location, make sure to arrive a bit earlier to get familiar with the place, so that you can help contributors find their way.
35+
</p>
36+
<h3 class="text-left">During the event</h3>
37+
<p class="text-left">
38+
Congratulations, you prepared a presentation and attracted many contributors.
39+
You have come with colleagues so each of you can focus on a couple of contributors.
40+
You can start with some general information about the project and then split into smaller groups to work on contributions. Contributors can work in pairs (or more). This usually helps people getting started, especially if they feel a bit nervous working alone on something completely new for them!<br />
41+
Take some breaks, enjoy the collaborations and have fun!
42+
</p>
43+
<p class="text-left">
44+
Some events have training sessions on technical topics (e.g. Git).
45+
This means that you must be ready to welcome new contributors in the middle of the event, once they completed their training.
46+
</p>
47+
<h3 class="text-left">After the event</h3>
48+
<p class="text-left">
49+
Please send to the organizers a recap of the contributions done during the event.
50+
</p>
51+
</div>
52+
</div>
53+
</div>
54+
</section>
55+
56+
<section id="contributors">
57+
<div class="container">
58+
<div class="row">
59+
<div class="col-sm-8 col-sm-offset-2 text-center">
60+
<i class="fa fa-4x fa-laptop wow bounceIn text-primary"></i>
61+
<h2 class="section-heading">Protips for contributors</h2>
62+
<hr class="primary">
63+
<h3 class="text-left">Do I qualify?</h3>
64+
<p class="text-left">
65+
Short answer: yes, you do!
66+
</p>
67+
<p class="text-left">
68+
hack-commit-push events welcome people of all backgrounds and experiences.
69+
You do not need to be an expert to start contributing to the project of your choice.
70+
Project leads will help you ramp up and answer any question you may have.
71+
This is a golden opportunity for you to learn about a new technical environment,
72+
new practices and give back to a project at the same time. Everyone wins!
73+
</p>
74+
<h3 class="text-left">Before the event starts</h3>
75+
<p class="text-left">
76+
Share the event with your friends and colleagues!
77+
The more, the merrier!
78+
</p>
79+
<p class="text-left">
80+
Regularly scan the event's project list and see which ones are the most likely to interest you.
81+
You can even start "tipping your toes" by setting up the prerequisites on your laptop and reading the project documentation.
82+
</p>
83+
<p class="text-left">
84+
If you are on a budget and live far away from the event location, some events offer financial help for transportation. Reach out to the event organizers.
85+
</p>
86+
<h3 class="text-left">During the event</h3>
87+
<p class="text-left">
88+
Some events include trainings at the beginning (e.g. on Git).
89+
Feel free to attend and join a project later.
90+
</p>
91+
<p class="text-left">
92+
You do not have to work solo on a contribution. It may be more fun (and less intimidating) to learn with other attendees.
93+
</p>
94+
<h3 class="text-left">After the event</h3>
95+
<p class="text-left">
96+
If you liked the experience and the project you worked on, feel free to continue your contributions!<br/>
97+
If you are lucky, there will be a <a href="https://www.hackergarten.net/" rel="noopener" target="_blank">Hackergarten meetup</a> in your city. They usually occur one evening per month, in small groups, following the same organization as hack-commit-push events.<br/>
98+
If not, you can always start a new chapter and attract leads and contributors on a monthly basis. You can reach out to hack-commit-push organizers, they will be happy to help!
99+
</p>
100+
</div>
101+
</div>
102+
</div>
103+
</section>

_includes/nav.html

+9-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="container-fluid">
33
<!-- Brand and toggle get grouped for better mobile display -->
44
<div class="navbar-header">
5-
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
5+
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#main-navbar">
66
<span class="sr-only">Toggle navigation</span>
77
<span class="icon-bar"></span>
88
<span class="icon-bar"></span>
@@ -11,7 +11,7 @@
1111
</div>
1212

1313
<!-- Collect the nav links, forms, and other content for toggling -->
14-
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
14+
<div class="collapse navbar-collapse" id="main-navbar">
1515
<ul class="nav navbar-nav navbar-right">
1616
<li>
1717
<a class="page-scroll" href="#about">About</a>
@@ -22,6 +22,13 @@
2222
<li>
2323
<a class="page-scroll" href="#past">Past Events</a>
2424
</li>
25+
<li role="presentation" class="dropdown">
26+
<a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Participant protips <span class="caret"></span></a>
27+
<ul class="dropdown-menu">
28+
<li><a class="page-scroll" href="#leads">For project leads</a></li>
29+
<li><a class="page-scroll" href="#contributors">For contributors</a></li>
30+
</ul>
31+
</li>
2532
<li>
2633
<a class="page-scroll" href="#coc">Code of Conduct</a>
2734
</li>

_layouts/front.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
{% include about.html %}
1010
{% include upcoming.html %}
1111
{% include past.html %}
12+
{% include guides.html %}
1213
{% include coc.html %}
1314
{% include scripts.html %}
1415
</body>

css/main.scss

+12-7
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ body>section:nth-child(even) {
7373
}
7474

7575
#mainNav {
76-
& {
76+
&, .dropdown > * {
7777
border: none;
7878
background-color: transparent;
7979
color: $text-color;
@@ -88,21 +88,17 @@ body>section:nth-child(even) {
8888
border-bottom: 2px solid $border-color !important;
8989
}
9090

91-
&:hover {
92-
color: $secondary-color;
93-
}
94-
9591
}
9692

9793
#nav-twitter, #nav-github {
9894
font-size: 16pt;
9995
}
10096

101-
#bs-example-navbar-collapse-1 {
97+
#main-navbar {
10298
border: none;
10399
text-align: right;
104100

105-
&.in,&.collapsing{
101+
&.in, &.collapsing{
106102
background-color: darken(rgba($theme-primary, .9), 10%);
107103
}
108104

@@ -113,6 +109,11 @@ body>section:nth-child(even) {
113109
height: 30px;
114110
}
115111
}
112+
113+
.dropdown {
114+
ul.dropdown-menu { margin-top: 10px; margin-bottom: 0;}
115+
a:hover { background: none;}
116+
}
116117

117118
a:focus {
118119
border-bottom: none !important;
@@ -246,6 +247,10 @@ header .header-content {
246247
}
247248
}
248249

250+
#leads, #contributors {
251+
a { text-decoration: underline;}
252+
}
253+
249254
@media screen and (min-width: 576px) {
250255

251256
header .header-content {

0 commit comments

Comments
 (0)