Volunteer: Difference between revisions

Jump to navigation Jump to search
249 bytes removed ,  18 February 2012
Cleanup and update
m (link to new articles)
(Cleanup and update)
Line 1: Line 1:
{{cleanup}}
Many people think that contributing to [[FlightGear]] requires writing C++ code or doing [[Portal:Developer/3D Modelers|3D modeling]], and therefore feel that they cannot contribute directly. Not so. There are a whole variety of ways to make a valuable and satisfying contribution to FlightGear without having to be a developer. This page is intended to provide a starting point for those wanting to contribute, but who don't know how.
Many people think that contributing to [[FlightGear]] requires writing C++ code or doing [[Portal:Developer/3D Modelers|3D modeling]], and therefore feel that they cannot contribute directly. Not so. There are a whole variety of ways to make a valuable and satisfying contribution to FlightGear without having to be a developer. This page is intended to provide a starting point for those wanting to contribute, but who don't know how.


Line 12: Line 14:
To get a basic introduction on FlightGear core development, please see [[Howto: Starting core development]].
To get a basic introduction on FlightGear core development, please see [[Howto: Starting core development]].


==== Tell us if FlightGear works with your hardware ====
== Tell us if FlightGear works with your hardware ==
 
You can help fellow FlightGear users by telling us if FlightGear works with your hardware. Please see [[FlightGear Hardware Recommendations]], [[Problematic Video Cards]] and [[Notebooks known to run FlightGear]].
You can help fellow FlightGear users by telling us if FlightGear works with your hardware. Please see [[FlightGear Hardware Recommendations]], [[Problematic Video Cards]] and [[Notebooks known to run FlightGear]].


==== Create FlightGear screenshots ====
== Participate in the FlightGear Forums ==
 
Another easy way for getting started contributing is to create nice FlightGear screenshots, you can upload these to the wiki where they can then be used for the "picture of the week": http://wiki.flightgear.org/index.php/Category:Picture_of_the_week_2011
 
==== Create FlightGear videos ====
 
Many users like to capture their flights in FlightGear as a video, youtube is for example an excellent way for sharing such videos with fellow FlightGear users. Youtube videos can also be directly embedded in forum postings.
 
==== Create FlightGear screencasts (video tutorials) ====
 
Creating FlightGear related video tutorials is another excellent way for getting started contributing.
 
==== Participate in the FlightGear Forums ====
If you haven't done so already, please consider registering at the [http://www.flightgear.org/forums FlightGear forum], this is a very simple thing to do, but it makes it very easy to obtain and provide help and other support within the FlightGear community.
If you haven't done so already, please consider registering at the [http://www.flightgear.org/forums FlightGear forum], this is a very simple thing to do, but it makes it very easy to obtain and provide help and other support within the FlightGear community.


Taking extra care in your posting to avoid requiring the attention of the moderators is in some ways also a contribution. Doing so helps self-police the forums so that the moderators can spend their time doing constructive development.
Taking extra care in your posting to avoid requiring the attention of the moderators is in some ways also a contribution. Doing so helps self-police the forums so that the moderators can spend their time doing constructive development.


==== Check out the FlightGear Chat channel ====
== Check out the FlightGear Chat channel ==
{{Main article|FlightGear IRC channel}}
{{Main article|FlightGear IRC channel}}
To talk to fellow FlightGear users in realtime, you may want to check out the IRC chat channel.
To talk to fellow FlightGear users in realtime, you may want to check out the IRC chat channel.
This is also an excellent way for getting and providing community help, or for getting the latest news about FlightGear.
This is also an excellent way for getting and providing community help, or for getting the latest news about FlightGear.


==== Tell us about your own ideas and feature requests for improving FlightGear ====
== Tell us about your own ideas and feature requests for improving FlightGear ==
If you think you have a good idea or feature request for improving FlightGear, the FlightGear forums and the IRC channel are also an excellent way for getting feedback.
If you think you have a good idea or feature request for improving FlightGear, the FlightGear forums and the IRC channel are also an excellent way for getting feedback.


Another new way for posting feature requests and making suggestions is provided at http://code.google.com/p/flightgear-future/issues/list
Another new way for posting feature requests and making suggestions is provided at http://flightgear-bugs.googlecode.com
This is a Google code based issue tracker, specifically meant to be used for posting suggestions for new features.
 
== Help us write the FlightGear Newsletter ==
The FlightGear newsletter is a community driven newsletter that is created and edited using the wiki. All FlightGear users are invited to contribute to the newsletter. The only thing that is required is a wiki account, which is free and easy to register.


==== Help us write the FlightGear Newsletter ====
The FlightGear newsletter is a community driven newsletter that is created and edited using the wiki.
All FlightGear users are invited to contribute to the newsletter. The only thing that is required is a wiki account, which is free and easy to register.
Please feel free to add news about your own FlightGear related projects, or projects started by others to the newsletter.
Please feel free to add news about your own FlightGear related projects, or projects started by others to the newsletter.


You can find the draft of next month's newsletter at: [[Next newsletter]]
You can find the draft of next month's newsletter at: [[Next newsletter]]


Just tracking the forums, mailing lists or the IRC channel should provide you with plenty of opportunities for things that could be added to the newsletter. One simple thing for getting started -even without writing anything- is uploading screen shots showing recent FlightGear developments for use in the FlightGear newsletter.
Just tracking the forums, mailing lists or the IRC channel should provide you with plenty of opportunities for things that could be added to the newsletter. One simple thing for getting started - even without writing anything - is uploading screen shots showing recent FlightGear developments for use in the FlightGear newsletter.


==== Write FlightGear reviews ====
== Reviews ==
Another thing that can be easily done is reviewing FlightGear (or just certain parts of it, like for example scenery and/or aircraft) and submit your reviews to some of the flight simulation portals. Of course, you can also directly write your reviews using the FlightGear wiki.
Another thing that can be easily done is reviewing FlightGear (or just certain parts of it, like for example scenery and/or aircraft) and submit your reviews to some of the flight simulation portals. Of course, you can also directly write your reviews using the FlightGear wiki.


==== Help improve the Wiki ====
== Media ==
=== Screenshots ===
Another easy way for getting started contributing is to create nice FlightGear screenshots, you can upload these to the wiki where they can then be used for the "picture of the week": http://wiki.flightgear.org/index.php/Category:Picture_of_the_week_2011
 
=== Videos ===
Many users like to capture their flights in FlightGear as a video, youtube is for example an excellent way for sharing such videos with fellow FlightGear users. Youtube videos can also be directly embedded in forum postings.
 
=== Screencasts (video tutorials) ===
Creating FlightGear related video tutorials is another excellent way for getting started contributing.
 
=== Screenshot managers ===
In order to illustrate FlightGear's impressive and advancing capabilities it was recently suggested (and agreed) to conduct monthly screenshot competitions where users are encouraged to submit their best FlightGear screenshots, so that the very best screenshots will be posted on the webpage for one month. Participants are expected to make their submissions at the end of each month, submissions should not be directly sent to the user mailing list as attachments, rather participants are expected to upload their screenshots to some free webspace and send mails containing links to their screenshots to the FlightGear User mailing list. It will be the decision of the screenshot managers to determine which screenshots shall win the monthly competition and are thus uploaded to [http://www.flightgear.org www.flightgear.org]
 
Currently the screenshot competition is on hold.
 
== Documentation ==
 
=== FAQ-Maintainers ===
The FlightGear project is currently looking for people who are willing to help maintain the FAQ (which is quite out of date). If you you would like to get involved, please subscribe to the FlightGear Developers [[mailing list]] in order to discuss the details or simply start editing the [[FAQ|wiki FAQ]]
 
=== Improve the wiki ===
You can easily register a new account and help improve the wiki, for example by editing existing articles or creating new ones.
You can easily register a new account and help improve the wiki, for example by editing existing articles or creating new ones.
Also, many articles could be greatly improved just by adding a handful of relevant screenshots for illustration purposes. Proof reading existing articles is also greatly appreciated.
Also, many articles could be greatly improved just by adding a handful of relevant screenshots for illustration purposes. Proof reading existing articles is also greatly appreciated.
Line 65: Line 73:
After registration, you'll have to confirm your registration by clicking on the link sent to you by email.
After registration, you'll have to confirm your registration by clicking on the link sent to you by email.


==== Help review Wiki articles ====
=== Review wiki articles ===
Many wiki articles are [[:Category:Out of date|outdated]], or may simply need to be reviewed and improved for other reasons - your help in reviewing existing articles would be highly appreciated!
Many wiki articles are [[:Category:Out of date|outdated]], or may simply need to be reviewed and improved for other reasons - your help in reviewing existing articles would be highly appreciated!


==== Help translate the Wiki ====
=== Translate the Wiki ===
{{Main article|Help:Translate}}
{{Main article|Help:Translate}}
You can also help localize the Wiki by translating important articles into different languages.
You can also help localize the Wiki by translating important articles into different languages.
Line 75: Line 83:
Also, FlightGear itself can be easily translated by updating the files in $FG_ROOT/Translations. For details please see [[Howto: Translate FlightGear|Translating FlightGear]].
Also, FlightGear itself can be easily translated by updating the files in $FG_ROOT/Translations. For details please see [[Howto: Translate FlightGear|Translating FlightGear]].


==== Submitting bugs to the Bug Tracker ====
== Submitting bugs to the Bug Tracker ==
Bugs are currently being reported at [http://code.google.com/p/flightgear-bugs/ this tracker]. Feel free to contact one of the project owners to be added to the member list, if you would like to add a bug (or two). Reporting bugs accurately helps make bug fixing significantly easier for the developers.
Bugs are currently being reported at [http://code.google.com/p/flightgear-bugs/ this tracker]. Feel free to contact one of the project owners to be added to the member list, if you would like to add a bug (or two). Reporting bugs accurately helps make bug fixing significantly easier for the developers.
Another thing that is very helpful, is reviewing posted bug reports and see if you can reproduce/confirm them.
Another thing that is very helpful, is reviewing posted bug reports and see if you can reproduce/confirm them.


==== Providing patches for aircraft's -set.xml status fields ====
== Providing patches for aircraft's -set.xml status fields ==
One way you could easily contribute would be to submit patches to HEAD setting the "status" flag on each aircraft accurately. While it will require learning a bit about SCM, and XML, that would be a fine contribution. For a details on how the status should be arrived at see  [[Formalizing_Aircraft_Status]].
One way you could easily contribute would be to submit patches to HEAD setting the "status" flag on each aircraft accurately. While it will require learning a bit about SCM, and XML, that would be a fine contribution. For a details on how the status should be arrived at see  [[Formalizing_Aircraft_Status]].


==== Screenshot managers ====
== Creating interactive tutorials ==
In order to illustrate FlightGear's impressive and advancing capabilities it was recently suggested (and agreed) to conduct monthly screenshot competitions where users are encouraged to submit their best FlightGear screenshots, so that the very best screenshots will be posted on the webpage for one month. Participants are expected to make their submissions at the end of each month, submissions should not be directly sent to the user mailing list as attachments, rather participants are expected to upload their screenshots to some free webspace and send mails containing links to their screenshots to the FlightGear User mailing list. It will be the decision of the screenshot managers to determine which screenshots shall win the monthly competition and are thus uploaded to [http://www.flightgear.org www.flightgear.org]
 
Currently the screenshot competition is on hold.
 
==== FAQ-Maintainers ====
The FlightGear project is currently looking for people who are willing to help maintain the FAQ (which is quite out of date). If you you would like to get involved, please subscribe to the FlightGear Developers [[mailing list]] in order to discuss the details or simply start editing the [[FAQ|wiki FAQ]]
 
==== Creating interactive tutorials ====
FlightGear has a built-in [[Tutorials|tutorial]] system that is based on its scripting language [[Nasal]], this system is very flexible and can be used for creating interactive tutorials (or even missions) for use in FlightGear itself, in other words these tutorials run directly in the simulator.  
FlightGear has a built-in [[Tutorials|tutorial]] system that is based on its scripting language [[Nasal]], this system is very flexible and can be used for creating interactive tutorials (or even missions) for use in FlightGear itself, in other words these tutorials run directly in the simulator.  


Creating new tutorials, or updating and improving existing ones, is another great way for getting more familiar with FlightGear. For details please see [[Tutorials]].
Creating new tutorials, or updating and improving existing ones, is another great way for getting more familiar with FlightGear. For details please see [[Tutorials]].


==== Scenery Model Creators ====
== Scenery Model Creators ==
The FlightGear project maintains a steadily growing repository of [http://scenemodels.flightgear.org/models.php 3D models] for adding some eye-candy to the scenery. The world has always enough room left for your [http://scenemodels.flightgear.org/contribute.php contribution]. Please take the time to investigate what is already there and enjoy populating your favourite area.
The FlightGear project maintains a steadily growing repository of [http://scenemodels.flightgear.org/models.php 3D models] for adding some eye-candy to the scenery. The world has always enough room left for your [http://scenemodels.flightgear.org/contribute.php contribution]. Please take the time to investigate what is already there and enjoy populating your favourite area.


Line 101: Line 101:
For example, placing objects in the scenery with the [[UFO]] and submitting them to the Scenery Objects DB is pretty straightforward and takes very little time. Even an hour spent doing this would make a difference.
For example, placing objects in the scenery with the [[UFO]] and submitting them to the Scenery Objects DB is pretty straightforward and takes very little time. Even an hour spent doing this would make a difference.


==== Artwork Creators/Contributors ====
== Artwork Creators/Contributors ==
FlightGear itself would not be possible without the contribution of various types of artwork:
FlightGear itself would not be possible without the contribution of various types of artwork:
* Often aircraft developers have to use different resources to accomplish the goal of realistically modeling a particular aircraft. Contributing photographs, images, sounds all have value.
* Often aircraft developers have to use different resources to accomplish the goal of realistically modeling a particular aircraft. Contributing photographs, images, sounds all have value.
Line 118: Line 118:
* [[Shader requests]]
* [[Shader requests]]


==== HowTo Writers ====
== HowTo Writers ==
Various parts of FlightGear are currently not yet sufficiently documented, also available documentation is often not really suitable to be used by non-developers. This results in users being unaware of the wide range of features and possibilities that FlightGear supports already.  
Various parts of FlightGear are currently not yet sufficiently documented, also available documentation is often not really suitable to be used by non-developers. This results in users being unaware of the wide range of features and possibilities that FlightGear supports already.  


Line 127: Line 127:
Topics that could use some HowTos are listed in [[Article requests]].
Topics that could use some HowTos are listed in [[Article requests]].


==== Documentation Editors/Reviewers ====
== Documentation Editors/Reviewers ==
As already stated on the Wiki main page, FlightGear comes with a set of illustrated documentation, notably "The Manual". This piece of documentation aims at being printed onto paper and being read as a reference while you're exploring FlightGear - or simply taken with you on a long trip. If you are a skilled writer and a little bit familiar with LaTex, please take the time to dig into the [http://mapserver.flightgear.org/getstart.pdf PDF] or
As already stated on the Wiki main page, FlightGear comes with a set of illustrated documentation, notably "The Manual". This piece of documentation aims at being printed onto paper and being read as a reference while you're exploring FlightGear - or simply taken with you on a long trip. If you are a skilled writer and a little bit familiar with LaTex, please take the time to dig into the [http://mapserver.flightgear.org/getstart.pdf PDF] or
[http://mapserver.flightgear.org/getstart/ HTML] version. Instructions on how to get the source code are [http://www.gitorious.org/fg/getstart/ here].
[http://mapserver.flightgear.org/getstart/ HTML] version. Instructions on how to get the source code are [http://www.gitorious.org/fg/getstart/ here].
Line 140: Line 140:
If you intend to redo a major part of the current documentation, it is recommended that you first discuss this with the developers, to ensure that you do not end up documenting code that may also be subject to major changes or even removal altogether. Please contact the developers before launching into a major documentation effort.
If you intend to redo a major part of the current documentation, it is recommended that you first discuss this with the developers, to ensure that you do not end up documenting code that may also be subject to major changes or even removal altogether. Please contact the developers before launching into a major documentation effort.


==== Pre-Release Testers ====
== Pre-Release Testers ==
Pre-release testers will be regularly offered the opportunity to test development code without having to build the corresponding binaries themselves, it will be expected of you to provide feedback about your experiences with experimental code to the developers, you should be able to provide details about your hardware and software setup, as well as being able to follow developer requests to track down any potential issues. You should also be willing to test run all aircraft that are by default included in FlightGear's base package on the platforms you have access to in order to ensure that all default aircraft are working properly.
Pre-release testers will be regularly offered the opportunity to test development code without having to build the corresponding binaries themselves, it will be expected of you to provide feedback about your experiences with experimental code to the developers, you should be able to provide details about your hardware and software setup, as well as being able to follow developer requests to track down any potential issues. You should also be willing to test run all aircraft that are by default included in FlightGear's base package on the platforms you have access to in order to ensure that all default aircraft are working properly.


Line 147: Line 147:
Note: If you are interested in actually doing development for FlightGear, make sure to check out the [[Portal:Developer|Developer section]].
Note: If you are interested in actually doing development for FlightGear, make sure to check out the [[Portal:Developer|Developer section]].


==== Hosting a multiplayer server ====
== Hosting a multiplayer server ==
If you have access to a unix based server, another good opportunity for contributing would be to set up a multiplayer server for use with FlightGear, for details please check out [[Howto: Set up a multiplayer server]].
If you have access to a unix based server, another good opportunity for contributing would be to set up a multiplayer server for use with FlightGear, for details please check out [[Howto: Set up a multiplayer server]].


Navigation menu