Difference between revisions of "GettingStarted"

From crowdresearch
Jump to: navigation, search
(How to setup the environment?)
Line 1: Line 1:
 
== Current State ==
 
== Current State ==
  
'''The document is Under Construction
+
'''The document is Under Construction'''
'''
+
  
 
='''How to setup the environment?'''=
 
='''How to setup the environment?'''=
# Please go through [https://github.com/crowdresearch/crowdsource-platform/blob/develop2/README.md README]  
+
'''Please go through [https://github.com/crowdresearch/crowdsource-platform/blob/develop2/README.md README]'''
 
# Set up the local environment  
 
# Set up the local environment  
# Current folder structure:  
+
'''Take a look at the current folder structure:'''
## '''Backend:''' ''crowdsourcing''  Serializers, Validators, Viewsets, Models, Views, tests
+
# '''Backend:''' ''crowdsourcing''  Serializers, Validators, Viewsets, Models, Views, tests
## '''Front End'''  ''statcfiles'' css, js (angular services, controllers) Angular routes Configurations, templates html  
+
# '''Front End'''  ''statcfiles'' css, js (angular services, controllers) Angular routes Configurations, templates html  
## '''Admin''' ''csp''  
+
# '''Admin''' ''csp''
#More Information about the [http://crowdresearch.stanford.edu/w/index.php?title=Infrastructure#System_Architecture Architecture]   
+
'''System Architecture'''
#System Architecture
+
# Below is the over view of architecture. For more Information [http://crowdresearch.stanford.edu/w/index.php?title=Infrastructure#System_Architecture please see]   
 +
# [http://crowdresearch.stanford.edu/w/img_auth.php/3/31/HCI_Data_Model.jpg Data Models]
 +
# http://nvie.com/posts/a-successful-git-branching-model/
 +
# Vision
 +
 
 
[[File:ARCHITECTURE.png| 500px|center| thumb| System Architecture ]]
 
[[File:ARCHITECTURE.png| 500px|center| thumb| System Architecture ]]
  
 
='''What to work on?'''=
 
='''What to work on?'''=
#  Take a look at the Open Issues   
+
=== Working on the existing issues  ===
#  Choose the issue you would like to work on
+
#  Take a look at the Open Issues  [[File:ReleaseCycle.png| 350px|right| thumb| Release Cycle & Tags]]
#  Add it to the google doc: Issue Name, Your Name, Your Git Hub Id  
+
#  Helpful '''search tags''': <code>Open & Critical, Need Help, Unassigned Please Pick This </code>
 +
#  Choose the issue you would like to work on  
 +
#  Add it to the google doc: Issue Name, Your Name, Your Git Hub Id
 +
#  If you want to raise request for the new issue or feature (see the section below)
 +
 
 +
=== Creating New issue/feature Requests:  ===
 +
# If you want to create new issue, task, feature request add it the [https://github.com/crowdresearch/crowdsource-platform/issues Github Issue Tracker]
 +
# Below Git Labels highlight various tags that needs to be associated with the issue.
 +
# For the request to be considered add following tags
 +
 
 +
## 0. Feature Request
 +
## 0. Please Prioritize
 +
## Add the one tags from 1 to 9 describing category of your request.
 +
## Assign it to yourself and in the description add following tags: 
 +
### For Category 1 DESIGN: add @neilthemathguy in the description
 +
### For Category 2 FRONT END ENGINEERING: add @neilthemathguy, @nistala and @dmorina in the description
 +
### For Category 3 SYSTEMS: add @dmorina, @elsabakiu, and @neilthemathguy
 +
### For Category 4 DATA: add @dmorina @neilthemathguy in the description
 +
### For Category 5 DEPLOYMENT: add @ksetyadi, @dmorina, and @neilthemathguy in the description
 +
### For Category 6 SECURITY: add @ksetyadi, @dmorina, and @neilthemathguy in the description 
 +
### For Category 7 ANALYTICS: add @neilthemathguy and @dmorina in the description
 +
### For Category 8 TESTING: add @neilthemathguy and @dmorina in the description
 +
### For Category 9 OTHERS: add @neilthemathguy and @dmorina in the description
 +
 
 +
 
 +
 
 +
 
 +
 
 +
='''How to submit the work'''=
 
# While raising the pull request add the issue number to the request, it will help to cross reference the release
 
# While raising the pull request add the issue number to the request, it will help to cross reference the release
  
Line 28: Line 59:
 
# Released to Production
 
# Released to Production
  
=== Creating New issue/feature Request  ===
 
# If you want to create new issue, task, feature request add it the [https://github.com/crowdresearch/crowdsource-platform/issues Github Issue Tracker]
 
# Below Git Labels highlight various tags that needs to be associated with the issue.
 
 
[[File:ReleaseCycle.png| 400px|center| thumb| Release Cycle & Tags]]
 
  
 
== Tasks, Issues, Feature Requests Breakdown ==
 
== Tasks, Issues, Feature Requests Breakdown ==

Revision as of 14:35, 10 May 2015

Current State

The document is Under Construction

How to setup the environment?

Please go through README

  1. Set up the local environment

Take a look at the current folder structure:

  1. Backend: crowdsourcing Serializers, Validators, Viewsets, Models, Views, tests
  2. Front End statcfiles css, js (angular services, controllers) Angular routes Configurations, templates html
  3. Admin csp

System Architecture

  1. Below is the over view of architecture. For more Information please see
  2. Data Models
  3. http://nvie.com/posts/a-successful-git-branching-model/
  4. Vision
System Architecture

What to work on?

Working on the existing issues

  1. Take a look at the Open Issues
    Release Cycle & Tags
  2. Helpful search tags: Open & Critical, Need Help, Unassigned Please Pick This
  3. Choose the issue you would like to work on
  4. Add it to the google doc: Issue Name, Your Name, Your Git Hub Id
  5. If you want to raise request for the new issue or feature (see the section below)

Creating New issue/feature Requests:

  1. If you want to create new issue, task, feature request add it the Github Issue Tracker
  2. Below Git Labels highlight various tags that needs to be associated with the issue.
  3. For the request to be considered add following tags
    1. 0. Feature Request
    2. 0. Please Prioritize
    3. Add the one tags from 1 to 9 describing category of your request.
    4. Assign it to yourself and in the description add following tags:
      1. For Category 1 DESIGN: add @neilthemathguy in the description
      2. For Category 2 FRONT END ENGINEERING: add @neilthemathguy, @nistala and @dmorina in the description
      3. For Category 3 SYSTEMS: add @dmorina, @elsabakiu, and @neilthemathguy
      4. For Category 4 DATA: add @dmorina @neilthemathguy in the description
      5. For Category 5 DEPLOYMENT: add @ksetyadi, @dmorina, and @neilthemathguy in the description
      6. For Category 6 SECURITY: add @ksetyadi, @dmorina, and @neilthemathguy in the description
      7. For Category 7 ANALYTICS: add @neilthemathguy and @dmorina in the description
      8. For Category 8 TESTING: add @neilthemathguy and @dmorina in the description
      9. For Category 9 OTHERS: add @neilthemathguy and @dmorina in the description



How to submit the work

  1. While raising the pull request add the issue number to the request, it will help to cross reference the release


What is the Release Cycle

Three Phase Cycle

  1. Development
  2. Staging Ready for Production
  3. Released to Production


Tasks, Issues, Feature Requests Breakdown

Task categorization is highlighted in the below diagram, depending on your interest please pick up the issue listed in the below list. You can use the label to search the issue on Git.

Tasks