Skip to content

Commit 841876b

Browse files
committed
application: add note about refactoring projects
1 parent 91a20e5 commit 841876b

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

General-Application-Information.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,43 @@ The Git organization usually has very limited mentoring capacity.
122122
These days we usually accept between 0 and 3 students per season
123123
(Winter or Summer).
124124

125+
## Note about refactoring projects versus projects that implement new features
126+
127+
Over the years we have been favoring refactoring projects over
128+
possibly more interesting projects that implement new features.
129+
Refactoring projects are usually easier to do step by step, and to get
130+
code merged step by step which is encouraging.
131+
132+
In general refactoring projects are worthwhile to do even if the
133+
project is not finished at the end of the GSoC and even if the student
134+
stops contributing after that. In those cases it is often a good idea
135+
to later finish the refactoring either by ourselves or by proposing it
136+
to another GSoC student or Outreachy intern. This way the work of both
137+
students and mentors is not likely to be wasted.
138+
139+
With a project that implements a feature, there is a risk, if it's too
140+
complex or too difficult, that the feature will not be finished and
141+
that nothing, or nearly nothing, will have been merged during the GSoC
142+
or Outreachy internship. There is also the risk that another way to
143+
implement the feature will appear later in the GSoC or Outreachy
144+
internship, and all, or nearly all, the work of the student and
145+
mentors will have been mostly wasted. It could also appear that the
146+
use cases the feature was envisioned to be used in, are better
147+
addressed by other improvements or a different workflow.
148+
149+
Another potential issue is that a new feature might be prone to naming
150+
or user interface discussions which could last for a long time or
151+
could not result in clear decisions.
152+
153+
Therefore we think that we should be very careful before proposing to
154+
a student, or accepting, a project that implements a new feature.
155+
People suggesting such a project should at least carefully consider
156+
the above potential issues and see if they can be mitigated before the
157+
project is submitted.
158+
159+
As [suggested by Google](https://google.github.io/gsocguides/mentor/defining-a-project-ideas-list)
160+
(but this is true for Outreachy internships too), we emphasize that a
161+
student proposing something original must engage with the community
162+
strongly before and during the application period to get feedback and
163+
guidance to improve the proposal and avoid the above potential issues.
164+

0 commit comments

Comments
 (0)