Difference between revisions of "Google Code In 2017/background"

From Sugar Labs
Jump to navigation Jump to search
(add links to ubuntu, fedora and debian install guides, add macOS for virtualisation, add link to SoaS, remove out of date, and add link to developer documentation)
(emphasize the importance of following the Contributing Page guidelines)
Line 21: Line 21:
 
=== Getting started with GIT ===
 
=== Getting started with GIT ===
  
Some knowledge of git is important as your work will be submitted to our git repository (https://github.com/sugarlabs). The basic mechanism is a pull request (PR), which is detailed in [http://developer.sugarlabs.org/contributing.md.html].
+
Some knowledge of git is important as your work will be submitted to our git repository (https://github.com/sugarlabs). The basic mechanism is a pull request (PR), which is detailed in [http://developer.sugarlabs.org/contributing.md.html]. ''It is required that you follow the steps outlined on the Contributing Page when doing coding and documentation tasks in GCI.''
  
 
GitHub provides a tutorial (See https://try.github.io/levels/1/challenges/1), although there are many others as well.
 
GitHub provides a tutorial (See https://try.github.io/levels/1/challenges/1), although there are many others as well.

Revision as of 10:30, 12 October 2017

Setting up the Sugar environment

There are several options for setting up the Sugar environment for development.

  • Install Sugar on Ubuntu, Fedora, or Debian, using apt or dnf;
  • From Windows. macOS or iOS, run Sugar in a virtual machine;
  • Live boot from Sugar on a Stick;
  • or better yet, use Sugar Live Build containing Sugar 0.112, which can be booted from hard drive, flash drive, and optical media, automatically starting Sugar without persistence; or can be installed as a virtual machine, with persistence and password protection, and contains all build dependencies, configured source trees (git clones in /usr/src), and binaries (make install) for Sugar 0.112 (Download from http://people.sugarlabs.org/~quozl/sugar-live-build-20171009/).

See also https://developer.sugarlabs.org/dev-environment.md.html

Getting started with coding in Sugar

Most Sugar development is in either Python or JavaScript.

Please note that you must run pep8 and pyflakes on your code before submitting your patches.

Getting started with GIT

Some knowledge of git is important as your work will be submitted to our git repository (https://github.com/sugarlabs). The basic mechanism is a pull request (PR), which is detailed in [1]. It is required that you follow the steps outlined on the Contributing Page when doing coding and documentation tasks in GCI.

GitHub provides a tutorial (See https://try.github.io/levels/1/challenges/1), although there are many others as well.

Note that our bug tracker is http:bugs.sugarlabs.org.

Getting started with Sugarizer

Sugar Web Framework is the JavaScript Framework for Sugar [2]. Sugarizer [3] is a subset of Sugar that allow runing activities developed with Sugar Web Framework on any web browser. Sugarizer is also available as Android, iOS, Firefox OS and Chrome Web App.