Difference between revisions of "Contributing"

From Mumble Wiki
Jump to: navigation, search
 
(Positional Audio)
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
Mumble is a great program, but that is no reason to stop polishing it. There are numerous areas where the development team needs help, and if you feel like contributing, then any of the below is for you.
 
Mumble is a great program, but that is no reason to stop polishing it. There are numerous areas where the development team needs help, and if you feel like contributing, then any of the below is for you.
 +
 +
== Find and report Bugs, suggest features ==
 +
Use the developer snapshots of Mumble and Murmur (downloads on [[Main_Page|main page]]) and see if you can find any issues with them. If you do, check if the issue has already been reported, add details if you have more, or add a new tracker item if it has not been reported yet. The '''issue tracker''' can be found at https://github.com/mumble-voip/mumble/issues.
 +
 +
You may also want to '''suggest new features''' at https://sourceforge.net/tracker/?group_id=147372&atid=768008
 +
 +
== Design / Layout ==
 +
We are in search of someone motivated to create a skin for our MediaWiki (this wiki/website). As you can see we currently use the default style but would like a better and more unique look.
 +
 +
For more information, suggestions and work-in-progess things see [[Contributing/WikiLayout]] (also includes refactoring of current codebase/html etc).
  
 
== Documentation ==
 
== Documentation ==
  
=== Wiki ===
+
Mumble and all around it needs documentation. Great documentation for a great program.
  
The Wiki documents are more or less up to date. It would be very helpfull if someone went through them all and made them completely up to date.
+
'''Wiki:''' The Wiki documents are more or less up to date. It would be very helpful if someone went through them all and made them completely up to date. See categories [[:Category:Please Improve|Please Improve]], [[:Category:Documentation|Documentation]].
  
=== Wikipedia ===
+
'''Wikipedia:''' Someone that is not a development team member needs to maintain the [http://en.wikipedia.org/wiki/Mumble_%28software%29 article at Wikipedia]. At the moment it’s missing references; try to find some. (This requires more work than just googling). Contributing to or creating a mumble article on non-English Wikipedia are also appreciated. See Promotion section below.
  
Someone that is not a development team member needs to maintain the article at Wikipedia. At the moment it's missing references; try to find some. (This requires more work than just googling).
+
'''Ice methods:''' We have a [http://mumble.sourceforge.net/slice/ generated documentation for exposed Ice methods]. Although probably only developers using the doc will be able to understand it, please give us a note on any inconsistencies, errors or needed clarifications if you find them.
  
 
== Translation ==
 
== Translation ==
  
Mumble is currently actively translated in German and Spanish. We have many other translations, but they may be out of date. If you wish to do a translation, get in contact with the dev team through the forums.
+
Mumble currently (March 2014) '''supports 18 different languages'''. As more people get to know and use Mumble versions in their native languages become more and more important.
 +
 
 +
We are thankful for any contribution on translating. Please check the '''[[Language Translation]]''' page for more information.
  
 
== Promotion ==
 
== Promotion ==
  
Get the word out. This means more than writing about it on your blog ;) There are many providers of free murmur servers; coordinate with one of them and start promoting Mumble as the voicechat of choice for your favorite game.
+
Get the word out. This means more than writing about it on your blog ;)
 +
 
 +
* Ask (voice-)server hosters on if they also provide Mumble servers if you can’t find them.
 +
* Coordinate with one of the hosters providing free mumble servers and start promoting Mumble as the voicechat of choice for your favorite game.
 +
* Add mumble hosters you found to the [[Hosters]] page / update information.
 +
* Create How-Tos, Screencasts, Tutorials or Benchmarks on typical issues and topics, and publish them on prominent platforms.
 +
* Spread the word in groups – join our [http://steamcommunity.com/groups/Mumble_VoIP Steam Group]
  
 
== Skinning ==
 
== Skinning ==
  
Create a new skin for Mumble. Mumble supports extensive skinning, but so far this feature hasn't been used much.
+
Mumble skins bring variety into Mumbles design and choices for different tastes.
 +
 
 +
Create new skins for Mumble! Information can be found on our [[Skinning]] page.
  
 
== Coding ==
 
== Coding ==
  
=== Management suite ===
+
=== 3rd party Interfaces ===
 +
 
 +
Web interfaces, web-viewers, administration programs, CMS website modules – all neat things we would love to see! These could be written in any language supported by our [[Ice]] based RPC Interface (using the deprecated [[DBus]] Interface is no longer advised). You could start your own project or link up with [[3rd_Party_Applications|an already existing one]]. To get an idea about how interaction with Murmur might look like you can take a look at the example scripts in our git repositories script folder.
 +
 
 +
=== Ice authenticators ===
 +
 
 +
See [[Authenticators]]. We’re happy for every authenticator and authenticator improvement you and the community can bring us!
  
Murmur needs a management suite. Somthing much easier to use and more sophisticated than the silly examples we bundle.
+
=== Positional Audio ===
 +
Most of our positional audio plugins regularly break on game updates. To read on how you can help us update the plugins see the [[Pluginguide]] page. You can even fix the update-issue forever for open source games, or if you want to add positional audio to your game, see [[Link]].
  
=== DBus authenticators ===
+
=== Mumble itself ===
  
We currently ship with an authenticator that works with phpBB3. It would be a real bonus if we had more authenticators.
+
We are always looking for helping hands willing to contribute to mumble. You'll need a good understanding of C++ and previous knowledge in Qt is definitely helpful. The best way to get into mumble development is to link up with us on [[IRC]] (#mumble on freenode), there is always small stuff to do to get you started. Also check the [[Development]] page on more info about the source code and building it.
  
=== PHP D-Bus bindings ===
 
  
To use the DBus interface in webpages, it would be very beneficial if there were PHP bindings for DBus. This will be a bit of a job though, especially if you're going to support full introspection.
+
[[Category:Documentation English]]
 +
[[Category:Contribution]]
 +
[[Category:Development]]
 +
[[Category:Mumble project]]

Latest revision as of 22:10, 4 November 2016

Mumble is a great program, but that is no reason to stop polishing it. There are numerous areas where the development team needs help, and if you feel like contributing, then any of the below is for you.

Find and report Bugs, suggest features

Use the developer snapshots of Mumble and Murmur (downloads on main page) and see if you can find any issues with them. If you do, check if the issue has already been reported, add details if you have more, or add a new tracker item if it has not been reported yet. The issue tracker can be found at https://github.com/mumble-voip/mumble/issues.

You may also want to suggest new features at https://sourceforge.net/tracker/?group_id=147372&atid=768008

Design / Layout

We are in search of someone motivated to create a skin for our MediaWiki (this wiki/website). As you can see we currently use the default style but would like a better and more unique look.

For more information, suggestions and work-in-progess things see Contributing/WikiLayout (also includes refactoring of current codebase/html etc).

Documentation

Mumble and all around it needs documentation. Great documentation for a great program.

Wiki: The Wiki documents are more or less up to date. It would be very helpful if someone went through them all and made them completely up to date. See categories Please Improve, Documentation.

Wikipedia: Someone that is not a development team member needs to maintain the article at Wikipedia. At the moment it’s missing references; try to find some. (This requires more work than just googling). Contributing to or creating a mumble article on non-English Wikipedia are also appreciated. See Promotion section below.

Ice methods: We have a generated documentation for exposed Ice methods. Although probably only developers using the doc will be able to understand it, please give us a note on any inconsistencies, errors or needed clarifications if you find them.

Translation

Mumble currently (March 2014) supports 18 different languages. As more people get to know and use Mumble versions in their native languages become more and more important.

We are thankful for any contribution on translating. Please check the Language Translation page for more information.

Promotion

Get the word out. This means more than writing about it on your blog ;)

  • Ask (voice-)server hosters on if they also provide Mumble servers if you can’t find them.
  • Coordinate with one of the hosters providing free mumble servers and start promoting Mumble as the voicechat of choice for your favorite game.
  • Add mumble hosters you found to the Hosters page / update information.
  • Create How-Tos, Screencasts, Tutorials or Benchmarks on typical issues and topics, and publish them on prominent platforms.
  • Spread the word in groups – join our Steam Group

Skinning

Mumble skins bring variety into Mumbles design and choices for different tastes.

Create new skins for Mumble! Information can be found on our Skinning page.

Coding

3rd party Interfaces

Web interfaces, web-viewers, administration programs, CMS website modules – all neat things we would love to see! These could be written in any language supported by our Ice based RPC Interface (using the deprecated DBus Interface is no longer advised). You could start your own project or link up with an already existing one. To get an idea about how interaction with Murmur might look like you can take a look at the example scripts in our git repositories script folder.

Ice authenticators

See Authenticators. We’re happy for every authenticator and authenticator improvement you and the community can bring us!

Positional Audio

Most of our positional audio plugins regularly break on game updates. To read on how you can help us update the plugins see the Pluginguide page. You can even fix the update-issue forever for open source games, or if you want to add positional audio to your game, see Link.

Mumble itself

We are always looking for helping hands willing to contribute to mumble. You'll need a good understanding of C++ and previous knowledge in Qt is definitely helpful. The best way to get into mumble development is to link up with us on IRC (#mumble on freenode), there is always small stuff to do to get you started. Also check the Development page on more info about the source code and building it.