AutolabJS

GSoC Proposal Template

The GSoC applicants are requested to format their application using the outline given below. You can create a wiki page on your GitHub repository and fill the page with the required details. This page is available for download in markdown format.

It is important to fill the application in detail and get your mentors feedback as early as possible. Please submit your applications directly to GSoC 2019 website.

Table of Contents

Personal Information

Please provide your contact details.

Your Name:
Gmail Id:
Contact Number:
GitHub Username:
Website, Blog (if any):
Link to Resume:

Education details

Name of the University:
Relevant Course Work Completed:
Your University Major:
Expected Graduation Date:

Brief Biography

About you, your interest in open source and in AutolabJS in less than 300 words.

Project Title

Please provide a suitable project title. If you are selecting one of the projects from the Ideas page, you are welcome to keep the existing project title.

Description

Please write an introduction to your project here. This introduction provides an overview of the proposal and also briefly states the improvements being suggested in the proposal. The description should help answer the following questions:

  1. What is one major problem your project attempts to solve?
  2. Why is the problem important to AutolabJS project?
  3. How do you attempt to solve the problem?
  4. What is your solution?
  5. What are the likely performance limits of your solution?

Please limit your description to 1000 words.

Deliverables with Timeline

In a tabular format, specify all the deliverables you are planning to create. Please be as specific as possible. Please be realistic in terms of the deliverables being promised in the proposal. Be sure to provide a tentative timeline for all the deliverables.

S.No. Deliverable Completion Date  
1. Deliverable-1    
2. Deliverable-2    

Deliverable-1

Further details on deliverable-1.

Deliverable-2

Further details on deliverable-2.

Design

Provide the design details needed for implementing your proposal. The strength of your proposal lies in providing a design that can scale seamlessly from 50 to 5000 concurrent users. Where possible, you are encouraged to stick to the standard architectural and design patterns. All designs involve trade offs. Explanation of all the design tradeoffs is a must for a strong proposal.

Implementation

AutolabJS project uses ES6 technologies built on Node.js 8.x stack. We use appropriate technologies available in Node.js stack. The installation itself uses Docker, Ansible and shell scripts. Your proposal must make a strong attempt to work with in the technology stack of AutolabJS. Please select appropriate libraries in consultation with project mentor(s). In implementation section, you provide an implementation outline for the architecture and designs proposed in design section. If you are able to put together a skeleton implementation, then please provide a link to the corresponding GitHub commit.

Technical Competence

On a scale of 1 to 6 (with 1 being a novice and 6 being an expert), please rate your competence on the technologies needed for completing your GSoC project.

S.No. Technology Competence (1 to 6) Justification  
1. Node.js      
2. ECMA Script 6 (ES 6)      
3. Express.js      
4. Docker      
5. Ansible      
6. Shell      
7. GitHub      

Please feel free to modify the above table as per the requirements of your project idea.

Do provide hyperlinks to your prior work to justify your self-assessment under the competence column.

Have you made any contributions to AutolabJS project? If so, please list your pull request contributions.

Did you contribute to open source projects before? If so, please provide links to your contributions in other open source projects.

Have you setup the development branch of AutolabJS on your machine? If so, please upload the Docker logs and deployment configuration of all the AutolabJS components to a Dropbox folder and provide a read access to the contents of the folder. (Do remember to remove / change passwords from the configuration files.)

How do you plan to continue your work on AutolabJS project after GSoC is complete?

How comfortable are you with test-driven development (TDD)? Please provide evidence of your prior code which reflects this ability.

Administrative Information

Please provide links to your communication with the mentor? (links to Gitter conversation is sufficient.)

Have you got the approval of your mentor on the project proposal?

How do you plan to communicate with your mentor? How often will you communicate with your mentor?

How do you plan to keep a record of your progress in GSoC project?

How much of time and effort can you dedicate to your chosen GSoC project?

Do you have any other summer time commitments (internships etc.) that will impact your participation in GSoC? If so, how do you plan to balance your commitments?

If your school reopens before 19-August-2019, how do you plan to balance the school requirements and GSoC workload?

Miscellaneous

Any other relevant information to your GSoC application?

Acknowledgements

Our proposal template has benefited from work done by other open source organizations which participated in GSoC. A few notable examples are:

  1. Drupal GSoC Proposal Template by Chandan Singh
  2. Joomla GSoC proposal template
  3. Cloud-CV GSoC Proposal Template by Harsh Agrawal
  4. MyHDL GSoC page