-
Notifications
You must be signed in to change notification settings - Fork 41
Instructions for new contributors
Here are few instructions which will help you get started with GraphSpace and start making a contribution to it.
Create an account on GraphSpace and start using it. You can refer to GraphSpace Manual to learn how to use GraphSpace.
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.
Follow the installation instructions to install and run GraphSpace locally.
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.
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.
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.
You should also be familiar with other open source projects related to GraphSpace:
- graphspace-python
- Link: https://github.com/adbharadwaj/graphspace-python
- Python API client library for GraphSpace's REST APIs.
- CyGraphSpace
- Link: https://github.com/Murali-group/CyGraphSpace
- An extension which allows Cytoscape users to share their networks online by uploading them to GraphSpace.