Skip to content

Instructions for GSoC Students

Aditya Bharadwaj edited this page May 4, 2017 · 11 revisions

Instructions for GSoC Students

Bonding Period

Here is the list of things to take care of during the bonding period.

1. Start using GraphSpace

Create an account on GraphSpace and start using it. You can refer to GraphSpace Manual to learn how to use GraphSpace.

2. Setup the editor

We recommend everyone to use an IDE for development. You can refer to this post on StackOverflow to learn about the advantages of using an IDE.

We use PyCharm IDE for all of our python based development. PyCharm also provides the professional version for free to students. If your project involves Java development, Eclipse IDE is a very good IDE.

3. Run GraphSpace on your local machine

Follow the installation instructions to install and run GraphSpace locally.

4. Learn how to contribute to GraphSpace

Carefully go through the guidelines for contributing to GraphSpace.

Once you have gone through the guidelines, I would like all of you to fix or enhance the documentation for installing graphspace on a local machine. For example, add a description next to each requirement to explain their role in GraphSpace project. Another example of an enhancement would be to create a video showing GraphSpace installation and then hyperlinking it in the documentation.

The aim of this exercise is to ensure that all of you have GraphSpace installed locally and understand how to contribute to GraphSpace.

5. Start Interacting

Since GraphSpace is budding open source project, we like to log all of our technical conversations as GitHub issues. Therefore, if you have a technical question, you should create an issue with the question label.

All non-technical messages should be communicated via email. Make sure you CC the secondary mentors as well.

6. Start maintaining your project's wiki page.

We would like all of you to maintain a wiki page for your project. This page should contain the following details related to your project.

  1. Project description
  2. Implementation details
  3. Milestone Progress Report
  4. Blogs/Tutorials - As discussed during the proposal phase, we want all of you to write a blog or tutorial after each milestone(2 week period). The aim of the blog/tutorial is to create useful learning material for future contributors of GraphSpace.

We have created placeholder wiki pages for each of projects. To start with, go ahead and add your project proposal details to these pages.

7. NRNB GSoC Student-Mentor Agreement

Coordinate with your mentor to fill-in, sign and return the NRNB GSoC Student-Mentor Agreement by May 30th. You must have received an email from Alexander Pico about this.

Clone this wiki locally