Difference between revisions of "Contribute"

From Amahi Wiki
Jump to: navigation, search
 
(22 intermediate revisions by 7 users not shown)
Line 4: Line 4:
  
 
* Contribute to this wiki! That is probably the most direct and quick way to contribute. Your experience helps others install and run their HDA!
 
* Contribute to this wiki! That is probably the most direct and quick way to contribute. Your experience helps others install and run their HDA!
−
* Share your experience in the area or running a server and answer questions in the [http://forums.amahi.org community forums] or in the [https://lists.sourceforge.net/lists/listinfo/amahi-users users mailing list]. If you are an experienced user, others will appreciate your efforts and this will make the project more usable and successful in the long run
+
* Share your experience in the area or running a server and answer questions in the [http://forums.amahi.org community forums]. If you are an experienced user, others will appreciate your efforts and this will make the project more usable and successful in the long run
 
* Talk about Amahi! Let people know what Amahi is about, help them install their HDA
 
* Talk about Amahi! Let people know what Amahi is about, help them install their HDA
 
* Promote Amahi, such as doing a presentation to your local LUG (Linux User Group), share your presentation with others!
 
* Promote Amahi, such as doing a presentation to your local LUG (Linux User Group), share your presentation with others!
−
* Blog about your experience with Amahi
+
* Blog or tweet about your experience with Amahi
 
* Make recommendations
 
* Make recommendations
 
* Do reviews or HOWTOs
 
* Do reviews or HOWTOs
−
* Help us create a polished "press kit" of sorts that we can give when managines and website editors ask us about Amahi
+
* Help us create a polished "press kit" of sorts that we can give when magazines and website editors ask us about Amahi
 
* [[How to Create a new Theme|Create a theme or two]]
 
* [[How to Create a new Theme|Create a theme or two]]
−
* Help us write a "manual" so that it's printable (in pdf and also [http://lulu.com, in paper])
+
* Help us write a "manual" so that it's printable (in pdf and also [http://lulu.com in paper])
 
* Submit to other sites that may like it! :-)
 
* Submit to other sites that may like it! :-)
  
Line 19: Line 19:
 
Aside from the above, there are two major ways to contribute in a more active role.
 
Aside from the above, there are two major ways to contribute in a more active role.
  
−
= Becoming an Application Maintainer =
+
= Types of Contributor =
  
−
* This is very easy. If you are an expert, or even if you only know the basics of some application installation and configuration, this is a great way to contribute
+
We have three types of contributor, from less involved to more involved:
−
* Get in touch with <code>support at amahi dot org</code> indicating what application you would like to maintain and we will set you up as a application maintainer
 
  
−
= Contributing Code =
+
* '''Editor:''' editing the apps "visual" part for English readability, HTML validation, logo/screenshot "shininess" and generally making beta apps look good
 +
* '''Tester''': testing, rating and sending feedback on beta apps
 +
* '''Packager''': packaging apps. no programming required
  
−
* Join the [https://sourceforge.net/mailarchive/forum.php?forum_name=amahi-devel amahi-devel list]
+
You can become any (or all) of these three roles by making yourself known to the community in the forums or in the IRC channel and asking to become a contributor!
−
* Grab a copy of the git repo
 
−
      git clone git://git.amahi.org/amahi.git
 
−
* Get yourself familiar with the pieces, and ask questions!
 
−
* Make some changes to the code, then test them:
 
−
* e.g. for testing the platform:
 
  
−
      cd platform/platform/html
+
= Becoming an Application Packager/Contributor =
−
      ./script/server
 
  
−
    and access it at http://hda:3000
+
* This is very easy. Whether you are an expert or you only know the basics of some application installation and configuration, this is a great way to contribute
 +
* Read the [[Application Contributor]] Guide
  
−
* You can see your changes with two git tools: status and diff
+
= Other Ways to Contribute =
  
−
      git status
+
What if I want to contribute but don't have the time to package an app?
  
−
  this gives you a list of what files were modified, added or removed. you can see changes in your area with:
+
Well here's a solution: you can find some apps for our developement team to package and we can do that for you. All you have to do is supply a link to the apps homepage and we will jump right on it. [[New_App_Ideas|NEW app ideas]] to add you app ideas to the list. Any and all apps are ok.
  
−
      git diff --cached
+
= Contributing Code =
−
 
 
−
  when you know you want to modify a file, you add it to the changes to be committed:
 
−
 
 
−
      git add README        (for example)
 
−
 
 
−
  for the parts that are added and checked in, you can see the changes with
 
−
 
 
−
      git diff
 
−
 
 
−
  this is what will be committed!
 
−
 
 
−
* Then commit your changes to your git repo:
 
−
 
 
−
      git commit
 
−
 
 
−
* After that you can generate a patch to be sent upstream, e.g. for a patch of the latest commit:
 
−
 
 
−
      git format-patch HEAD^..HEAD
 
−
 
 
−
  This will generate a file called 0001-my-patch.mbox or similar
 
−
  (type ls -l 00*), which then you can email or pastebin it to someone
 
−
  to be committed upstream.
 
−
 
 
−
* Please note, your name and email WILL be officially in the [http://git.amahi.org amahi git repo] as as contributor, which mean it's in the open and it's crawlable, so please use your name/email accordingly.
 
  
−
* For more details, ask in the [http://forums.amahi.org forums], [https://sourceforge.net/mailarchive/forum.php?forum_name=amahi-devel amahi-devel list], or come by the [http://embed.mibbit.com/?server=irc.freenode.net&channel=%23amahi&noServerNotices=true&noServerMotd=true&autoConnect=true IRC channel]
+
Follow this page to [[contribute code]].

Latest revision as of 21:33, 7 April 2014

There are a few ways to contribute and get involved and with Amahi!

Here is a list of ideas that the community has been suggesting:

  • Contribute to this wiki! That is probably the most direct and quick way to contribute. Your experience helps others install and run their HDA!
  • Share your experience in the area or running a server and answer questions in the community forums. If you are an experienced user, others will appreciate your efforts and this will make the project more usable and successful in the long run
  • Talk about Amahi! Let people know what Amahi is about, help them install their HDA
  • Promote Amahi, such as doing a presentation to your local LUG (Linux User Group), share your presentation with others!
  • Blog or tweet about your experience with Amahi
  • Make recommendations
  • Do reviews or HOWTOs
  • Help us create a polished "press kit" of sorts that we can give when magazines and website editors ask us about Amahi
  • Create a theme or two
  • Help us write a "manual" so that it's printable (in pdf and also in paper)
  • Submit to other sites that may like it! :-)

... remember, it has to be fun and enjoyable for you, take as little time as possible, and help the community!

Aside from the above, there are two major ways to contribute in a more active role.

Types of Contributor

We have three types of contributor, from less involved to more involved:

  • Editor: editing the apps "visual" part for English readability, HTML validation, logo/screenshot "shininess" and generally making beta apps look good
  • Tester: testing, rating and sending feedback on beta apps
  • Packager: packaging apps. no programming required

You can become any (or all) of these three roles by making yourself known to the community in the forums or in the IRC channel and asking to become a contributor!

Becoming an Application Packager/Contributor

  • This is very easy. Whether you are an expert or you only know the basics of some application installation and configuration, this is a great way to contribute
  • Read the Application Contributor Guide

Other Ways to Contribute

What if I want to contribute but don't have the time to package an app?

Well here's a solution: you can find some apps for our developement team to package and we can do that for you. All you have to do is supply a link to the apps homepage and we will jump right on it. NEW app ideas to add you app ideas to the list. Any and all apps are ok.

Contributing Code

Follow this page to contribute code.

Retrieved from "https://wiki.amahi.org/index.php?title=Contribute&oldid=82622"