Difference between revisions of "Summer of Code/2015/GIT.JR"

From Sugar Labs
Jump to navigation Jump to search
(Created page with "===About You=== * Gabriel Cemaj * gabriel@cemaj.com * Gabriel Cemaj * What is your IRC nickname on irc.freenode.net? * Spanish/English * San Diego. Any time during the day is...")
 
Line 12: Line 12:
  
 
* Git.jr
 
* Git.jr
* The idea came from one of the suggested proposals for the GSoF for Sugar Labs, but I want to expand it a bit further. While now a days we are working hard to create curriculum for the young for them to learn how to code at a young age, and while we are quickly integrating programming as an essential part of the education system we are not teaching them how to document and share their code properly. So while we are making huge strides to ensure the future generations know how to code we are neglecting the equally important task pf teaching them how to properly share that code with the world and to do in a way that i well documented. The idea is to create a kid friendly verioning repo mainly for the sugar labs platform, but the end goal would be to make this a global entry to the world of git, and other repo's. So the goal is to make a user friendly introduction to version for kids to version their code while also making a documentation system to go along with it. So that kids can start from a young age to document and version their code and programming projects.    
+
* The idea came from one of the suggested proposals for the GSoF for Sugar Labs, but I want to expand it a bit further. While now a days we are working hard to create curriculum for the young for them to learn how to code at a young age, and while we are quickly integrating programming as an essential part of the education system we are not teaching them how to document and share their code properly. So while we are making huge strides to ensure the future generations know how to code we are neglecting the equally important task pf teaching them how to properly share that code with the world and to do in a way that i well documented. The idea is to create a kid friendly verioning repo mainly for the sugar labs platform, but the end goal would be to make this a global entry to the world of git, and other repo's. So the goal is to make a user friendly introduction to version for kids to version their code while also making a documentation system to go along with it. So that kids can start from a young age to document and version their code and programming projects, essentially creating a layer between the user and git that would simplify the way they can version and document the code. This would be done using the git python API to create the UI, and the back end will be in c so that it can run nice and fast.     
* What is the timeline for development of your project? The Summer of Code work period is from May 19 - August 22; tell us what you will be working on each week. (As the summer goes on, you and your mentor will adjust your schedule, but it's good to have a plan at the beginning so you have an idea of where you're headed.) Note that you should probably plan to have something "working and 90% done" by the midterm evaluation (27 June); the last steps always take longer than you think, and we will consider cancelling projects which are not mostly working by then.
+
* Timeline:
 +
** Start of Project May 19: Initial analysis of the way journal works right now.
 +
** 1st Week May 17 - May 23: Decide what can stay and be reused and what needs to be rewritten.
 +
*** The idea is to have a sort of re-fresh so there will have to be a decision made in what code needs to be kept and what needs to be re implemented
 +
** 2nd Week May 24 - May 30: The Back end
 +
***This is the time to rebuild the back end, this will need to handle all the "git" stuff that are simply not "pretty" and have it ready to be accessed by a UI layer that can sit nicely on top.  
 +
** 3rd Week May  31 June 6: Finish Back end
 +
*** The goal for this would be to finish the "git" back end and the documentation journal that will be implemented to nicely and easily store documentation for users.
 +
** 4th Week June 7 - June 13: Start the Front end
 +
*** This is where the UI comes. Mostly done in Python this front end will be a simple and easy way to verison and document sugar lab projects.
 +
** 5th Week June 14 -June 20: Finish Front end
 +
*** Finish up the front end UI, and get it ready for some testing.
 +
** 6th Week: June 21- June 27: Code Review
 +
*** Commence final testing and code review to head towards completion of the project. Or at least by the end of this week there should be a finished and working project that can version and document the user's code in a nice and simple manner locally.
 +
** 7th Week  June 28 - July 4th: Moving online
 +
*** Now that the local side of the project is up and running we can start working on connecting it to an online repo. This will entail creating a simple solution to exporting it to existing sites such as gitHub or to create a more "kid" friendly alternative where kids can store their code and work on it from home or another computer.   
 +
** 8th Week July 5 - July 11: Finishing online
 +
*** By the end of this week the goal ois to have a working and functional mechanism to connect our newilt created repo to an online one be it to a new "SugarLabsHub" or to an existing repo website.  
 
* Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
 
* Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.
  

Revision as of 13:15, 24 March 2015

About You

  • Gabriel Cemaj
  • gabriel@cemaj.com
  • Gabriel Cemaj
  • What is your IRC nickname on irc.freenode.net?
  • Spanish/English
  • San Diego. Any time during the day is usually good
  • This will be first open-source project! How exciting is that? At least i'm excited. I really want to be a part of the open source community mainly because of the community. The idea of working together with all sort of people from all sorts of places and this super sweet common goal while doing in so in an open shared environment seems to me as the programmings answer to the "Giving back" question, and that really moves me. So while still learning, i do so quickly and have plenty of enthusiasm to go around.

About your project

  • Git.jr
  • The idea came from one of the suggested proposals for the GSoF for Sugar Labs, but I want to expand it a bit further. While now a days we are working hard to create curriculum for the young for them to learn how to code at a young age, and while we are quickly integrating programming as an essential part of the education system we are not teaching them how to document and share their code properly. So while we are making huge strides to ensure the future generations know how to code we are neglecting the equally important task pf teaching them how to properly share that code with the world and to do in a way that i well documented. The idea is to create a kid friendly verioning repo mainly for the sugar labs platform, but the end goal would be to make this a global entry to the world of git, and other repo's. So the goal is to make a user friendly introduction to version for kids to version their code while also making a documentation system to go along with it. So that kids can start from a young age to document and version their code and programming projects, essentially creating a layer between the user and git that would simplify the way they can version and document the code. This would be done using the git python API to create the UI, and the back end will be in c so that it can run nice and fast.
  • Timeline:
    • Start of Project May 19: Initial analysis of the way journal works right now.
    • 1st Week May 17 - May 23: Decide what can stay and be reused and what needs to be rewritten.
      • The idea is to have a sort of re-fresh so there will have to be a decision made in what code needs to be kept and what needs to be re implemented
    • 2nd Week May 24 - May 30: The Back end
      • This is the time to rebuild the back end, this will need to handle all the "git" stuff that are simply not "pretty" and have it ready to be accessed by a UI layer that can sit nicely on top.
    • 3rd Week May 31 June 6: Finish Back end
      • The goal for this would be to finish the "git" back end and the documentation journal that will be implemented to nicely and easily store documentation for users.
    • 4th Week June 7 - June 13: Start the Front end
      • This is where the UI comes. Mostly done in Python this front end will be a simple and easy way to verison and document sugar lab projects.
    • 5th Week June 14 -June 20: Finish Front end
      • Finish up the front end UI, and get it ready for some testing.
    • 6th Week: June 21- June 27: Code Review
      • Commence final testing and code review to head towards completion of the project. Or at least by the end of this week there should be a finished and working project that can version and document the user's code in a nice and simple manner locally.
    • 7th Week June 28 - July 4th: Moving online
      • Now that the local side of the project is up and running we can start working on connecting it to an online repo. This will entail creating a simple solution to exporting it to existing sites such as gitHub or to create a more "kid" friendly alternative where kids can store their code and work on it from home or another computer.
    • 8th Week July 5 - July 11: Finishing online
      • By the end of this week the goal ois to have a working and functional mechanism to connect our newilt created repo to an online one be it to a new "SugarLabsHub" or to an existing repo website.
  • Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.

You and the community

  • If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
  • What will you do if you get stuck on your project and your mentor isn't around?
  • 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?

Miscellaneous

  • We want to make sure that you can set up a development environment before the summer starts. Please do one of the following:
    • Send us a link to a screenshot of your Sugar development environment with the following modification: when you hover over the XO-person icon in the middle of Home view, the drop-down text should have your email in place of "logout".
    • Send us a link to a pull request or merge request you have made on a Sugar or Sugar activity bug.
It's normal to need assistance with this, so please visit our IRC channel, #sugar on irc.freenode.net, and ask for help.
  • Describe a great learning experience you had as a child.
  • Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?