Skip to content

Commit bd4f85e

Browse files
committed
SoC-2019-Microprojects: add section for ONE microproject
1 parent 5460227 commit bd4f85e

File tree

1 file changed

+32
-8
lines changed

1 file changed

+32
-8
lines changed

SoC-2019-Microprojects.md

+32-8
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,43 @@ the time of your formal application; we mostly want to see that you
119119
have a basic level of competence and especially the ability to
120120
interact with the other Git developers.
121121

122-
Students: Please attempt only **ONE** microproject. We want quality,
122+
## Only ONE quality focused microproject per student
123+
124+
Students, please attempt only **ONE** microproject. We want quality,
123125
not quantity! (Also, it takes work to collect the ideas, and it would
124-
be nice to have enough microprojects for everybody.) This means that
125-
for microproject that consist in refactoring or rewriting a small
126-
amount of code, your patch should change only **ONE** file, or perhaps
127-
2 files if they are closely related, like "foo.c" and "foo.h".
126+
be nice to have enough microprojects for everybody.)
127+
128+
This means that for a microproject that consist in refactoring or
129+
rewriting a small amount of code, your patch should change only
130+
**ONE** file, or perhaps 2 files if they are closely related, like
131+
"foo.c" and "foo.h".
132+
133+
If you change a test file, the title of your patch should start with
134+
"tXXXX: " where tXXXX is the start of the filename of the test script
135+
you change. If you change "foo.c" or "foo.h", the title of your patch
136+
should probably start with "foo: ".
137+
138+
In general it's a good idea to check on the mailing list archive what
139+
other GSoC students attempting a microproject have already been told
140+
this year or any previous year, as hopefully it will help you avoid
141+
some mistakes. As some microproject ideas haven't changed for years,
142+
some microprojects might have been attempted many times already and
143+
you can learn a lot from these attempts.
144+
145+
The more you research your microproject and take advantage of that,
146+
the more confident we can be that you will be able to solve many
147+
problems when working on your real GSoC project. So it's a very good
148+
thing to show that you have researched your microproject and taken
149+
into account what you have found.
128150

129151
If you've already done a microproject and are itching to do more, then
130152
get involved in other ways, like finding and fixing other problems in
131153
the code, or improving the documentation or code comments, or helping
132154
to review other people's patches on the mailing list, or answering
133155
questions on the mailing list or in IRC, or writing new tests, etc.,
134-
etc. In short, start doing things that other Git developers do!
156+
etc. In short, start doing things that other Git developers do!
157+
Alternatively you can of course focus on your
158+
[project proposal](https://git.github.io/SoC-2019-Ideas).
135159

136160
## Ideas for microprojects
137161

@@ -157,7 +181,7 @@ already been done for a number of languages.
157181

158182
### Use `test_path_is_*` functions in test scripts
159183

160-
Find a test script that verifies the presence/absence of
184+
Find one test script that verifies the presence/absence of
161185
files/directories with 'test -(e|f|d|...)' and replace them with the
162186
appropriate `test_path_is_file`, `test_path_is_dir`, etc. helper
163187
functions.
@@ -166,7 +190,7 @@ functions.
166190

167191
See the commit
168192
[c6f44e1da5](https://github.com/git/git/commit/c6f44e1da5e88e34)
169-
for example.
193+
for example, and then do the same thing in one other test script.
170194

171195
### Use unsigned integral type for collection of bits.
172196

0 commit comments

Comments
 (0)