Difference between revisions of "Summer of Code/2018/Making a Beginner Guide"

From Sugar Labs
Jump to navigation Jump to search
Line 64: Line 64:
  
  
===Project and the community===
+
'''Bold text'''===Project and the community===
# '''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
+
#'''If your project is successfully completed, what will its impact be on the Sugar Labs community?'''
 
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.  
 
::* If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.  
 
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
 
::* FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
Line 73: Line 73:
 
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.  
 
::* Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.  
 
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
 
::* In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
# '''What will you do if you get stuck on your project and your mentor isn't around?'''
+
#'''What will you do if you get stuck on your project and your mentor isn't around?'''
 
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
 
::* I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
 
::* Read the documentation of the tool in which problem occurs.
 
::* Read the documentation of the tool in which problem occurs.
 
::* Contact other SugarLabs members through IRC, developer mailing lists
 
::* Contact other SugarLabs members through IRC, developer mailing lists
 
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
 
::* If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
# '''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
+
#'''How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?'''
  
 
===Other Commitments===
 
===Other Commitments===

Revision as of 11:43, 16 March 2018

Google Summer of Code 2018 Project Proposal

Project Name: Making a Beginner Guide | Developer’s dashboard | Sugarbot

Mentors

Jaskirat Singh
Hrishi Patel
Rishabh Thaney
Shivang Shekhar
Samson Goddy
Abdulazeez Abdulazeez

My Profile

Name: Pratul Kumar
University::The LNM Institute of Information and Technology
Course: B.Tech. in Communications and Computer Engineering
Year: 2nd year (4th semester)
Email: pratulkumar1997@gmail.com
Telephone: +91-8107525493
IRC: Pratul1997
Github: https://github.com/Pratul1997
Sugar Labs wiki UserName: Pratul1997
Linkedin: https://www.linkedin.com/in/pratul1997/
Facebook: https://www.facebook.com/Pratul1997
Languages: English, Hindi
Time-Zone: Jaipur , India UTC+5:30

Open Source Contribution

  • Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?
Yes I have been contributing to Open Source since September 2017.
  • Organisations :
  • Sugarlabs
  • CybrosX (Open-Source Organisation of my college Computer Club)
  • I am managing one Open-Source organization of my college.
  • My first Pull request: Removed Material CSS #14
  • Open Source is a self-learning and motivational path for me and I want to completely indulge in this practice for 3 months during this summer.

Project Proposal Information

Proposal Abstract

  • To make a beginners guide for the SugarLabs Community. A platform for guiding them how to contribute through making these form :
  • Where to start?
  • What to start?
  • How to start?
  • Where to submit?
  • We need to convert the markdown and grasp the information from different places to bring all the information at a single place which can also be used as sugarlabs.github.io
  • The basic goal is to help new developers to our community to get settled easily in the world of SugarLabs.
  • To work to make a dashboard for the users so that they can get to know about developed and developing areas, track the project as well as their progress and performance. Their contribution could also be seen by the community.

Current Status of Project

Dashboard Features

Badge Feature in Dashboard

Add Shortcuts

Sugarbot

Counterpart the Risks

Bold text===Project and the community===

  1. If your project is successfully completed, what will its impact be on the Sugar Labs community?
  • If the project is successful it will be of huge help for new developers to SugarLabs as well as establish all the documentation at one place in a well-organized way. This will also give first-time users a pleasant experience as they wouldn’t have to figure out all the procedures by themselves.
  • FAQ’s like “How to download the Sugar labs projects” and “how to start contributing” would be taken care of at a single place in a decently organized way.
  • To make it more user-friendly there would be testing as well as feedback and suggestions from the users so as to make changes accordingly.
  • Dashboard will bring all the community features at a single place and badges would reflect how much a user has used our documentation and how much of help it has been.
  • If there is some part of the documentation that is not completed by the majority of the newcomers, (this can be seen by the number of badges with the students) then more emphasis will be laid to that part for more refining.
  • Sugarbot will be a new project to Sugar labs which could be further expanded and embedded within our chatting and mailing channel.
  • In future, it could also be utilized for assigning issues thus increasing automation and productivity. There seems to be a lot of scope for Sugarbot’s expansion.
  1. What will you do if you get stuck on your project and your mentor isn't around?
  • I will try to resolve the issue myself by looking it up on Google, StackOverflow etc.
  • Read the documentation of the tool in which problem occurs.
  • Contact other SugarLabs members through IRC, developer mailing lists
  • If the problem is still not resolved, I will engross myself on some other module to keep the things rolling and wait for my mentors to help me out.
  1. How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?

Other Commitments