Difference between revisions of "Activity Team/Getting Involved"
Line 18: | Line 18: | ||
* '''Create a new project''' (http://git.sugarlabs.org, projects, new). Make your project name lowercase, e.g. pippy, turtleart, paint. Put it in '''category "activities"'''. | * '''Create a new project''' (http://git.sugarlabs.org, projects, new). Make your project name lowercase, e.g. pippy, turtleart, paint. Put it in '''category "activities"'''. | ||
* [[Activity_Team/Git_FAQ#How_do_I_create_a_new_project.3F|Initiate]] your project | * [[Activity_Team/Git_FAQ#How_do_I_create_a_new_project.3F|Initiate]] your project | ||
− | * | + | * You can copy/paste [http://git.sugarlabs.org/projects/hello-world Hello World] activity to get an example of usual files hierarchy. |
* You can place your activity to ~/Activities/'''activity-name'''.activity directory.<br>To test your activity in sugar environment: | * You can place your activity to ~/Activities/'''activity-name'''.activity directory.<br>To test your activity in sugar environment: | ||
** use ''sugar'' command to run sugar as a regular window manager | ** use ''sugar'' command to run sugar as a regular window manager |
Revision as of 06:47, 2 August 2009
Install Sugar
The easiest way is installing sugar from native packages.
If your favourite GNU/Linux distribution doesn't provide sugar or contains out-of-dated packages(in most cases you don't need latest minor release(like 0.82.1, 0.84.1), the good practise is looking for the last major release(0.82, 0.84)) you could consider possibility to use sugar-jhbuild - the system used by core developers to build sugar from last git sources.
As an activity developer in most cases you need only glucose module(its included to sugar-glucose or sugar packages).
If you want to create your own activity
What you need to do to create or share your activity.
Start coding
- Create an account on http://git.sugarlabs.org and log in. Add your public SSH key to your account.
- Create a new project (http://git.sugarlabs.org, projects, new). Make your project name lowercase, e.g. pippy, turtleart, paint. Put it in category "activities".
- Initiate your project
- You can copy/paste Hello World activity to get an example of usual files hierarchy.
- You can place your activity to ~/Activities/activity-name.activity directory.
To test your activity in sugar environment:- use sugar command to run sugar as a regular window manager
- use sugar-emulator command to run sugar in window mode(in Xephyr), could be useful to test your activity in current environment without re-loginning.
- Start coding :)
If you want to share your activity for broad audience(it could be not final release):
- Open a ticket on dev.sugarlabs.org to create component for your activity e.g. [1]
- Using setup.py from activity root directory, create .pot file
- Add the pootle user as a committer (from the "add committer" link on the mainline page) and send mail to Sayamindu to point pootle(sugar translation environment) to new remote.
- Open a ticket on dev.sugarlabs.org to add your activity to pootle e.g. [2]
- Upload a xo bundle(use setup.py to create bundle) to addons.sugarlabs.org.
- Be sure to include a couple of screenshots of your activity in action.
- Nominate your activity to the public
- Create activity page wiki.sugarlabs.org/go/Activities/<activity-name>
keep in mind that page on addons.sugarlabs.org targeted to users and page on wiki targeted to developers
Join the Activity Team
The Activity Team is newly formed and we are seeking members.
If you would like to join:
- Create a User page on wiki.sugarlabs.org if you have not already.
- Copy your SSH public key into your User page.
- Add a link to your User page to Activity Team/Contacts.
- Subscribe, and send an email introducing yourself to sugar-devel@lists.sugarlabs.org.
If you are an independent developer who is interested in working on a Sugar activity, please introduce yourself and your project in an email to sugar-devel@lists.sugarlabs.org.
Help the Activity Team
If you'd rather just start coding right now, it's easy to do!
- Check Activity Team/TODO for ideas to work on. To start small, pick an Activity Feature Request. If you'd rather work on something harder, try one of the High Impact Tasks.
- If you haven't already set up Sugar, see Activity Team/Resources.
- Clone the Git repository for the project you picked and register it with Sugar.
git clone <project_url> cd project_name python setup.py dev (Ctrl-Alt-Erase to restart Sugar)
- Hack on the source code.
- Create a patch file containing your changes.
git commit git format-patch -1
- Email 0001-My-change-description.patch to sugar-devel@lists.sugarlabs.org.