Difference between revisions of "Contribute"

From MythTV Official Wiki
Jump to: navigation, search
(Developer documentation)
m (Testing: change "SVN" to what it really meant)
(41 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Did you know you to can help contributing to MythTV?
+
Everyone has the skills to contribute to MythTV. Remember that MythTV is a combination of technical and non-technical efforts. There are many ways that you and your friends can contribute to improve MythTV even further.
  
You to can help by contributing to MythTV development and documentation. Besides [[Development guide | developers]] we need people to work on manuals and documentation, layout and design, wiki pages or translations. Join us making MythTV even beter than it already is.
 
  
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.
+
''Join us making your favorite media center even better than it already is today.''
  
Look at the summary below and choose how you can help best.
 
  
 +
=== 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 '''[[Development guide | here]]'''.
  
= Things you can do to help =
 
  
== Improving the manual ==
+
MythTV is primarily written in C++. 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 you can communicatie with other users and developers on our [[Community | '''Community page''']].
'''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]].
 
  
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]]
+
=== Theme ===
  
== Maintaining the Wiki (this site) ==
+
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.
'''Required skills:''' non technical
+
  
If you are not familiar with '''using a wiki''' than you can learn it in no-time [[Help:Contents | here]].
 
  
You can help writing and editing material right here on the Wiki.  
+
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 or by reading the '''[[MythUI Theme Development | Theme development guide]]'''.
* Help completing pages that are marked incomplete. You can find an complete list of this [[: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.
+
  
==Improve the screenshots page==
+
=== Plugin ===
'''Required skills:''' non technical
+
  
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.
+
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 (e.g. MythWeather). You can also choose to read the '''[[Plug-in_developers_guide | Plug-in development guide]]'''.
  
== Promoting MythTV (Bring MythTV to the rest of us ==
 
'''Required skills:''' non technical, basic internet usage.
 
  
Help us bringing MythTV to the rest of us by writing articles, references, talking in forums, etc.
+
=== Help ===
  
It's also a good idea to post MythTV in news groups as an HTPC or Mediacenter solution. A lot of people just don't know about the existence of MythTV and the possibilities.
+
provide assistance to other users on our mailinglists and IRC-channels. Learn more [[Community| '''here''']]
  
== internationalizing/translating ==
 
'''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.
+
=== Testing ===
  
== Testing MythTV ==
+
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 unstable/development 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 '''[[Development guide | here]]'''.
'''Required skills:''' non technical, some understanding of MythTV
+
  
Beta testing new features is always appreciated. 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.
+
=== Translations ===
  
== Creating and improving MythTV themes==
+
If you have language skills, you can work on internationalizing/translating the product.  This is needed in the core system as well as in the plugins. Read more about it '''[[Translation | here]]''' and join the mailing list [http://www.mythtv.org/mailman/listinfo/mythtv-translators here].
'''Required skills:''' some technical knowlegde
+
  
If you are interested in creating a new theme, read the [[theme development guide]] section for how to get started.
+
=== Documentation ===
  
== Building plugins ==
+
Documentation always has room for improvement and often lags behind features. Improving the documentation to makes it easier for new users and developers to get started with MythTV. Which is important for MythTV to grow and improve. Find suggestion about where to start on the '''[[Documentation suggestions]]''' page.
'''Required skills:''' Light to heavy programming knowlegde
+
  
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.
+
===Still not sure how to help?===
  
==Software documentation==
+
Visit our IRC-based development discussions, our send us a message through the mailinglist. You can find more info about this [[Community | '''here''']].
'''Required skills:''' Some understanding of programming
+
  
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.
 
  
==Software developing==
+
=== Promotion ===
'''Required skills:''' light to heavy understanding of programming
+
 
 +
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, and chatrooms, etc.
 +
 
  
Off course there is enough software development to do. You can find out all about this in the [[Development guide]]. Variating from debugging, optimizing to developing new features.
 
  
  
{{Incomplete}}
 
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]
 
[[Category:Knowledge Base]]
 
[[Category:Knowledge Base]]
 +
[[Category:HOWTO]]

Revision as of 22:55, 26 December 2010

Everyone has the skills to contribute to MythTV. Remember that MythTV is a combination of technical and non-technical efforts. There are many ways that you and your friends can 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++. 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 you can communicatie with other users and developers on our Community page.


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 or by reading the Theme development guide.

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 (e.g. MythWeather). You can also choose to read the Plug-in development guide.


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 unstable/development 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 in the plugins. Read more about it here and join the mailing list here.

Documentation

Documentation always has room for improvement and often lags behind features. Improving the documentation to makes it easier for new users and developers to get started with MythTV. Which is important for MythTV to grow and improve. Find suggestion about where to start on the Documentation suggestions page.


Still not sure how to help?

Visit our IRC-based development discussions, our send us a message through the mailinglist. You can find more info about this here.


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, and chatrooms, etc.