Difference between revisions of "Contribute"

From MythTV Official Wiki
Jump to: navigation, search
m (HowToHelp moved to Contribute: sounds better)
(Improved text and readability)
Line 1: Line 1:
 +
Everyone has the skills to contribute to MythTV. Remember that MythTV is a combination of technical and non-technical efforts. There are many ways for you and friends to contribute to improve MythTV even further.
  
= Things you can do to help =
 
  
Did you know you to can help contributing to MythTV?
+
''Join us making your favorite media center even better than it already is today.''
  
Everyone has one or more skills to help improving MythTV. You just have to remember that MythTV is a combination of technical and non-technical efforts. Independent from your skills, there is always something you can do to help make MythTV even beter than it is right now.
 
  
Besides more [[Development guide | developers]] we also need people to work on manuals and documentation, themes, wiki pages, translations and more. Join us making MythTV even better than it already is.
+
=== Code ===
  
The following list contains a selection where we need to work on for the improvement of MythTV. Choose how you can help best.
+
We welcome code contributions from anyone, whether you have a small fix or a new feature, a lot of programming experience or none at all. Learn more about writing code for MythTV '''[[Development guide | here]]'''.
  
  
==Software developing==
+
MythTV is primarily written in C++ and the skins in are written in Python. Feel free to talk to us about your code and experiments in our mailinglists and chatgroups. Or code something up and submit it as a patch or feature to us. find out how to contact us [[Development guide | '''here''']].
'''Required skills:''' light to heavy understanding of programming
 
  
Of course there is enough software development to do. The work varies from debugging, optimizing existing code to developing new features. You can find everything you want to know in the [[Development guide]]
 
  
==Documenting new and existing features==
+
=== Theme ===
'''Required skills:''' familiar with using MythTV
 
  
Documentation often lags behind features.  The [http://www.mythtv.org/mailman/listinfo/mythtv-commits mythtv-commits mailing list] provides information on what has been coded into the system recently and updating documentation here or in the official docs on mythtv.org is a welcome contribution.
+
If you are more into design and graphics you will like the theme possibilities in MythTV to create new looks for the users to look at.
  
== Improving the manual ==
 
'''Required skills:''' non technical
 
  
The user manual helps people to start and work with MythTV. There's a project underway to create a [[User Manual]] which is starting to pick up steam. If you know something about MythTV, you can help extending and updating the manual. You can find the manual [[User_Manual:Index | here]].
+
Theming can be as simple and complex as you want it to be. The best way to get started building your own theme is by experimenting with an existing theme. Learn more about this '''[[theme development guide | here]]'''.
  
The manual is available via the wiki pages, if you are not familiar with '''using a wiki''' than you can learn it in no-time [[Help:Contents | here]]
 
  
== Maintaining the Wiki (this site) ==
+
=== Plugin ===
'''Required skills:''' non technical
 
  
If you are not familiar with '''using a wiki''' than you can learn it in no-time [[Help:Contents | here]].
+
Users have the possibility to extend their system with extra functionality by simply adding plugins. Users and developers can write their own plugins that run within MythTV and can be controlled by remote. A fast and easy way to get started is by taking a small existing plugin to start with. You can learn more about this '''[[Plug-in_developers_guide | here]]'''.  
  
You can help writing and editing material right here on the Wiki.
 
* Help completing pages that are marked incomplete. You can find an complete list of incomplete pages [[:Category:Incomplete | here]].
 
* Review and update existing pages
 
* Look around and improve the wiki structure. By improving the Structure you help people finding the right information and makes or easier to keep things simple, organized and up-to-date.
 
  
==Improving the screenshots page==
+
=== Help ===
'''Required skills:''' non technical
 
  
Screenshots are important for new users to get familiar with MythTV. The [[Screenshots]] page needs to be fleshed out, preferably illustrating the default theme as well as a couple of others, and at least one widescreen. Where possible it would be good to add short notes beside the screenshots to help visitors understand them correctly.
+
provide assistance to other users on our mailinglists and IRC-channels. Learn more [[Development guide | '''here''']]
  
== Promoting MythTV ==
 
'''Required skills:''' non technical, basic internet usage.
 
  
You can help bringing MythTV to the rest of us in various ways. Some examples are:
+
=== Testing ===
* write articles about MythTV
+
 
* help new MythTV users with their problems in forums, chatrooms (e.g. IRC), etc.
+
Testing the latest version of MythTV is very important and timesaving for the developers. One does not need to be a developer to retreive the latest code and run it on their machine. But you do need to be aware that going to SVN code implies a certain responsibility on the user's part to debug their own problems, file useful bugreports, and be able to downgrade or upgrade accordingly to fix issues.
* Promote MythTV in news groups as a Mediacenter solution (or HTPC). A lot of people just don't know about the existence of MythTV and the possibilities.
+
 
* Post MythTV in binairy-newsgroups as a alternative to the illegal mediacenter downloads (or one of the easy to install [[MythTV_distros]]).
+
 
* remind people about the fact you don't need a expensive windows licence to use MythTV.
+
Find out how to get the latest code and run it on your machine [[Development guide | here]].
* suggest MythTV as a good alternative in mediacenter forums.  
+
 
* Etc.
 
  
== Internationalizing / translating ==
+
=== Translations ===
'''Required skills:''' non technical, understands one or more languages
 
  
 
If you have language skills, you can work on internationalizing/translating the product.  This is needed in the core system as well as the modules.
 
If you have language skills, you can work on internationalizing/translating the product.  This is needed in the core system as well as the modules.
  
== Testing MythTV ==
 
'''Required skills:''' non technical, some understanding of MythTV
 
  
Beta testing new features is always appreciated and very helpfull. One does not need to be a developer to pull code from SVN and compile it - but you do need to be aware that going to SVN code implies a certain responsibility on the user's part to debug their own problems, file useful bugreports, and be able to downgrade or upgrade accordingly to fix issues.
+
=== Documentation ===
  
How to pull code from SVN and compile it:
+
Documentation often lags behind features, improve the documentation to make it easier for new users and developers to get started with MythTV. Some suggestions:  
  
== Creating themes for MythTV==
+
* ''Wiki based manual'' - There's a project underway to create a user Manual which is starting to pick up steam. Contribute to [[User_Manual:Index | the manual]]. The manual is available via the wiki pages, if you are not familiar with '''using a wiki''' than you can learn it in no-time '''[[Help:Contents | here]]'''
'''Required skills:''' Light technical knowledge, some feeling for layout and design
 
  
If you are interested in creating a new theme, than you can find all you need to know in the following pages:
+
* ''Wiki'' - The '''[[Main_Page | wiki]]''' contains al the information that should not be in the user manual. keeping the wiki pages up-to-date helps users and developers to find the right information.
* [[theme development guide]] - All about creating new themes.
 
* [[Menu_theme_development_guide | Theme menu development guide]] - how to work with Theme menus.
 
* [[:Category:Themes | Theme Category page]] - Example themes and more links to relevant pages.
 
  
== Building plugins ==
+
* ''Screenshots'' - Screenshots are important for new users to get familiar with MythTV. The [[Screenshots]] page needs to be fleshed out, preferably illustrating the default theme as well as a couple of others, and at least one widescreen. Where possible it would be good to add short notes beside the screenshots to help visitors understand them correctly.
'''Required skills:''' Light to heavy programming knowledge
 
  
You can find more information about how you can build your own plug-in for MythTV (or convert and existing program)in the [[Plug-in_developers_guide | Plug-in_developers_guide]]
 
  
In general people find this a nice way to start developing on MythTV.
+
=== Promotion ===
 +
 
 +
You can help bringing MythTV to the rest of us in various ways. Some examples are:
 +
* write articles about MythTV
 +
* help new MythTV users with their problems in forums, chatrooms (e.g. IRC), etc.
 +
* Promote MythTV in news groups as a Mediacenter solution (or HTPC). A lot of people just don't know about the existence of MythTV and the possibilities.
 +
* Post MythTV in binairy-newsgroups as a alternative to the illegal mediacenter downloads (or one of the easy to install [[MythTV_distros]]).
 +
* remind people about the fact you don't need a expensive windows licence to use MythTV.
 +
* suggest MythTV as a good alternative in mediacenter forums.
 +
* Etc.
  
==Technical documentation==
 
'''Required skills:''' Some understanding of programming
 
  
Documentation often lags behind... help keeping this up-to-date.
 
  
{{Incomplete}}
 
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]
 
[[Category:Knowledge Base]]
 
[[Category:Knowledge Base]]
 
[[Category:HOWTO]]
 
[[Category:HOWTO]]

Revision as of 14:26, 7 November 2008

Everyone has the skills to contribute to MythTV. Remember that MythTV is a combination of technical and non-technical efforts. There are many ways for you and friends to contribute to improve MythTV even further.


Join us making your favorite media center even better than it already is today.


Code

We welcome code contributions from anyone, whether you have a small fix or a new feature, a lot of programming experience or none at all. Learn more about writing code for MythTV here.


MythTV is primarily written in C++ and the skins in are written in Python. Feel free to talk to us about your code and experiments in our mailinglists and chatgroups. Or code something up and submit it as a patch or feature to us. find out how to contact us here.


Theme

If you are more into design and graphics you will like the theme possibilities in MythTV to create new looks for the users to look at.


Theming can be as simple and complex as you want it to be. The best way to get started building your own theme is by experimenting with an existing theme. Learn more about this here.


Plugin

Users have the possibility to extend their system with extra functionality by simply adding plugins. Users and developers can write their own plugins that run within MythTV and can be controlled by remote. A fast and easy way to get started is by taking a small existing plugin to start with. You can learn more about this here.


Help

provide assistance to other users on our mailinglists and IRC-channels. Learn more here


Testing

Testing the latest version of MythTV is very important and timesaving for the developers. One does not need to be a developer to retreive the latest code and run it on their machine. But you do need to be aware that going to SVN code implies a certain responsibility on the user's part to debug their own problems, file useful bugreports, and be able to downgrade or upgrade accordingly to fix issues.


Find out how to get the latest code and run it on your machine here.


Translations

If you have language skills, you can work on internationalizing/translating the product. This is needed in the core system as well as the modules.


Documentation

Documentation often lags behind features, improve the documentation to make it easier for new users and developers to get started with MythTV. Some suggestions:

  • Wiki based manual - There's a project underway to create a user Manual which is starting to pick up steam. Contribute to the manual. The manual is available via the wiki pages, if you are not familiar with using a wiki than you can learn it in no-time here
  • Wiki - The wiki contains al the information that should not be in the user manual. keeping the wiki pages up-to-date helps users and developers to find the right information.
  • Screenshots - Screenshots are important for new users to get familiar with MythTV. The Screenshots page needs to be fleshed out, preferably illustrating the default theme as well as a couple of others, and at least one widescreen. Where possible it would be good to add short notes beside the screenshots to help visitors understand them correctly.


Promotion

You can help bringing MythTV to the rest of us in various ways. Some examples are:

  • write articles about MythTV
  • help new MythTV users with their problems in forums, chatrooms (e.g. IRC), etc.
  • Promote MythTV in news groups as a Mediacenter solution (or HTPC). A lot of people just don't know about the existence of MythTV and the possibilities.
  • Post MythTV in binairy-newsgroups as a alternative to the illegal mediacenter downloads (or one of the easy to install MythTV_distros).
  • remind people about the fact you don't need a expensive windows licence to use MythTV.
  • suggest MythTV as a good alternative in mediacenter forums.
  • Etc.