[SoC] GSoC 2018 - preparing for your final project submission

[Florin-Daniel Cioloboc]

Dear students,

Referring to the official GSoC timeline [1]:

* August 6-14: Students submit their work product (code) and a final
evaluation of their Mentor *

As part of your final evaluations, you have to provide a single URL to the
code you produced. It’s necessary that it points to the GSoC 2018 work
product. Failure to do so properly may result in failing the program.

Citing [1]:

“The target of the link should contain a short description of what work was
done, what code got merged, what code didn't get merged, and what's left to
do.”

------------------

Basic requirements of this final report are:

* It must be easy to identify the work you have done. When someone goes to
the provided URL it should be clear what work you did without requiring
them to do significant additional digging.

* It should be in a stable location. The URL cannot be changed after
submission.

* Someone else should be able to use the content at (or referenced from)
the target of the link to extend your work. If your work is 100% complete,
they should be able to use it. If your work is not 100% complete, it should
be clear what's left to do.

------------------

Based upon last years GSoC experiences, your final report has to include:

------------------

1- The title of the project and the software community it belongs to (for
hybrid projects indicate all the software involved);

2- Abstract: a description of the general idea, motivation, challenges,
etc.;

3- The state of the art BEFORE your GSoC. For example, if you made a GUI,
you can say: "In the software XYZ, when I wanted to use the tool xxx, I had
to manually edit the file yyy";


4- The addition (added value) that your project brought to the software. In
the same example: "With the GUI that I created, now it is possible to use
the tool xxx via graphical user interface";

5- If there is still work to be done on the project, include that too. You
can also share highlights or challenging pieces.

6- Add all the permanent links to access the code and documentation for the
user to get started with testing your application. "Please test my code
following instructions here". (Don’t forget to test that the links are
working and
do not require special access permissions!) Ensure that the pull request
description is detailed. If the pull request is going to have more work
done after GSoC is over, make sure the last GSoC commit is noted.

7- At least an image that should serve to show the main elements of your
project. It could be a flow chart, a screenshot, both, or whatever you
think could serve for the scope. Remember: the aim is to showcase your
project to people that are not necessarily familiar with the software. The
image must  be loaded on a public repository or in the web page / wiki of
your project and the link  shall be included in your report.

8- Optional: you can add links to videos, blog posts etc. that you have
Created. (We really encourage it.)

------------------

In order to comply with the requirement of *a report in a stable location
(the URL cannot be changed after submission)*, send your final report
structured in the above mentioned way to this SOC mailing list.  Please
note that:

   -

   the report must be written as text inside your email (not as a separate
   attached document, not as a link to an external document)


You can find your final report mail in the SoC Archives (
https://lists.osgeo.org/pipermail/soc/) and then use this permanent link to
your final report mail in your GSoC final submission in your dashboard.

Please let us know if you have any doubts or need assistance.

There are about 2 and a half weeks left to complete your GSoC project, it’s
time to prepare for wrap up your GSoC project. You should allocate the last
weeks mainly to code cleanup, documentation and testing.


Kind regards,

OSGeo GSoC admin team

[1] https://summerofcode.withgoogle.com/how-it-works/#timeline

[2] https://developers.google.com/open-source/gsoc/help/work-product
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/soc/attachments/20180720/714d27f7/attachment-0001.html>