Difference between revisions of "Contribute"
From Amahi Wiki
| Line 28: | Line 28: | ||
* Join the [https://sourceforge.net/mailarchive/forum.php?forum_name=amahi-devel amahi-devel list] | * Join the [https://sourceforge.net/mailarchive/forum.php?forum_name=amahi-devel amahi-devel list] | ||
* Grab a copy of the git repo | * Grab a copy of the git repo | ||
| + | |||
git clone git://git.amahi.org/amahi.git | git clone git://git.amahi.org/amahi.git | ||
| + | |||
* Get yourself familiar with the pieces, and ask questions! | * Get yourself familiar with the pieces, and ask questions! | ||
* Make some changes to the code, then test them: | * Make some changes to the code, then test them: | ||
| Line 42: | Line 44: | ||
git status | git status | ||
| − | + | * The status gives you a list of what files were modified, added or removed. you can see changes in your area with: | |
git diff --cached | git diff --cached | ||
| − | + | * When you know you want to modify a file, you add it to the changes to be committed, for example, say a README file: | |
| − | git add README | + | git add README |
| − | + | * For the parts that are added and checked in, you can see the changes with | |
git diff | git diff | ||
| − | + | * This is what will be committed! | |
| − | * Then commit your changes to your git repo: | + | * Then actually commit your changes to your git repo: |
git commit | git commit | ||
| − | * After that you can generate a patch to be sent upstream, e.g. for a patch of the latest 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 | 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. You probably want to [[Configure Git]] to your liking first to display the email properly. | |
| − | |||
| − | |||
* Please note, once the patch is applied upstream, 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. | * Please note, once the patch is applied upstream, 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] | * 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] | ||
Revision as of 18:36, 28 March 2009
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 or in the 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
- 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 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 managines 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.
Becoming an Application Maintainer
- 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
- Get in touch with
support at amahi dot orgindicating what application you would like to maintain and we will set you up as a application maintainer
Contributing Code
- Join the amahi-devel list
- 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
./script/server
and access it at http://hda:3000
- You can see your changes with two git tools: status and diff
git status
- The status gives you a list of what files were modified, added or removed. you can see changes in your area with:
git diff --cached
- When you know you want to modify a file, you add it to the changes to be committed, for example, say a README file:
git add README
- For the parts that are added and checked in, you can see the changes with
git diff
- This is what will be committed!
- Then actually 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. You probably want to Configure Git to your liking first to display the email properly.
- Please note, once the patch is applied upstream, your name and email WILL be officially in the 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 forums, amahi-devel list, or come by the IRC channel
