Skip to content

Instructions for new GSoC Mentors

Aditya Bharadwaj edited this page Feb 11, 2018 · 1 revision

Welcome to GraphSpace developer community!

Here are few instructions which will help you get started as a mentor with GraphSpace.

1. Start using GraphSpace

As a mentor you should be familiar with GraphSpace website and its documentation. So if you are new to GraphSpace project, 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. As a mentor, it is really necessary that you understand the guidelines for contribution and ensure that students follow it.

5. Improve the documentation

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. 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 with other contributors

One of the most important role of a mentor is to engage with other GraphSpace contributors (students and mentors) on GitHub. We log all of our technical conversations as GitHub issues. Try to answer queries on GitHub issues.

7. Fix an issue.

If you are a first time mentor, it is very important that you have contributed enough to GraphSpace codebase prior to GSoC period.

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.

8. Reviewing Code

As a mentor you need to learn how to review code. So please go ahead and start reviewing the recent open pull requests.

Instructions on how pull up the code locally for review

Let us say we are reviewing the pull request from melvin15may from b#262 branch.

git pull origin develop
git remote add melvin https://github.com/melvin15may/GraphSpace.git
git fetch melvin
git merge melvin/b#262

If you like the changes, give a thumbs up on GitHub and let the moderators know that you approve the changes.

Clone this wiki locally