Skip to content

Instructions for Potential GSoC Students

Aditya Bharadwaj edited this page Jan 23, 2018 · 3 revisions

Welcome to GraphSpace developer community!

Here are few instructions which will help you get started with GraphSpace and start making a contribution to it.

1. Choose a GSoC project

Go through the project descriptions and choose a project you would like to work on. Once you have chosen a project, comment on the Github issue and let us know that you are interested. You should also send an email with your resume/cv to mentors mentioned in the project description.

2. Start using GraphSpace

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

3. 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.

4. Run GraphSpace on your local machine

Follow the installation instructions to install and run GraphSpace locally.

5. 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.

6. 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.

7. Fix an issue.

We have a list of issues labeled with good first issue to help potential first-time contributors. Incase you like to fix an issue, you can comment on the given issue and let us know. You are welcome to fix other issues as well.

Clone this wiki locally