Home - Forums - Documentation - Gallery - Bugs
Current revision (10:34, 22 August 2008) (edit) (undo)
m (Protected "Contributing" [edit=sysop:move=sysop])
 
(23 intermediate revisions not shown.)
Line 1: Line 1:
= Contributing =
= Contributing =
-
Crystal Space is a big project. We always welcome people to help us improve Crystal Space. In particular we are interested in the following kind of people:
+
Crystal Space is a big project. We always welcome people to help us improve Crystal Space, and there are a wide variety of talents we can make use of.
-
* Coders with experience in OpenGL and 3D graphics in general.
+
* '''Coders'''. Most of Crystal Space consists of C++; the level of knowledge required depends on the part of the SDK.
-
* Coders with different backgrounds are obviously also needed. Crystal Space is a big project and many of our sub-projects are not directly related to 3D or even graphics.
+
** For work the core parts of the engine you should be proficient in C++ with some experience in ''OpenGL and/or 3D graphics'' in general.
-
* Coders for our [[Crystal Core]] project. This basically involves a lot of work on [[CEL]] and also good knowledge on how to use XML for scripting.
+
** Crystal Space is a big project and many of our sub-projects are not directly related to 3D or even graphics - for example, we have support for ''audio'', ''physics'', ''joystick input''... These parts also usually require a relatively low level of C++ knowledge.
-
* Documentation writers. We have documentation but some parts are lacking and some parts are completely missing.
+
** We have a custom ''build system''. So if you're good at writing shell we always welcome a hand here.
-
* Artists. For our [[Crystal Core]] project we need 3D, 2D, sound, and music artists.
+
** If you're good in other languages, maintaining bindings for that language may be something for you.
 +
* Coders for our [[Crystal Core]] project. This basically involves a lot of work on [[CEL]] and also good knowledge on how to use CEL's XML script language.
 +
* '''Documentation writers'''. We have documentation but some parts are lacking and some parts are completely missing. Even if you're just mostly reading the documentation, we always welcome improvements - clarifications, rewordings for readability, expanding some of the API docs...
 +
* '''Artists'''. For our [[Crystal Core]] project we need 3D, 2D, sound, and music artists. For Crystal Space itself we need nice levels and demos to show off what it can do, and the occasional test level.
 +
* '''Web Designers/Developers'''. Some aspects of our web site are customized or need custumization (e.g. skins). Maintenance and updates is needed here as well. The [http://www.crystalspace3d.org/trac/homepage/report/1 web site bug tracker] lists things that need to be done.
 +
* '''Public Relations'''. This may not be as obvious but one way you can help contribute to Crystal Space is by doing public relations for us. i.e. tell the world how good you think Crystal Space is. On [[Public Relations|this page]] you can find more information on things you can do to help promote Crystal Space.
 +
* '''Donate Money'''. You can also do a monetary donation if you want. We will use this money for a 'good' Crystal Space related goal. In this case for example the new Apricot Open Game project. You can donate here [https://sourceforge.net/donate/index.php?group_id=649 SourceForge Donation Page]. If you want to donate money some other way then [mailto:jorrit.tyberghein@gmail.com contact us].
 +
 
 +
== “Getting in” ==
 +
Contributing to CS is easy:
 +
 
 +
* If you have found a bug and fixed it, go ahead and open a new issue on the [http://trac.crystalspace3d.org/trac/CS/ issue tracker], with your bug attached.
 +
* The same goes for smaller enhancements and documentation improvements.
 +
* If you're just curious but don't have anything specific to be done in mind, look at the [http://trac.crystalspace3d.org/trac/CS/report/1 open tickets] on the bug tracker.
 +
* Usually we'll grant SVN access after a couple of patches were accepted and committed.
 +
* It's always a good idea to subscribe to the <tt>main</tt>, <tt>dev</tt> and <tt>cvs</tt> [[Community#Mailing_Lists|mailing lists]].
 +
* If you have some “bigger” idea (write a new plugin, make a bigger enhancement/change) write a mail to the main developers.
= Report Bugs =
= Report Bugs =
Line 13: Line 29:
Go to the [[Bugs]] page to report bugs in Crystal Space, [[CEL]], or [[Crystal Core]].
Go to the [[Bugs]] page to report bugs in Crystal Space, [[CEL]], or [[Crystal Core]].
-
= Developers White Board =
+
{{BugReporter}}
 +
 
 +
= Developer's White Board =
 +
 
 +
For all our projects we have a developer wiki which is separate from this site.
 +
Crystal Space and CEL also have SourceForge projects. You can find them in the following table:
-
In the [[DevelopersWhiteBoard]] you can write down notes related to development of Crystal Space.
+
{|border="0" cellspacing="2" cellpadding="6"
 +
|-
 +
| [[Image:cs-compact.png|left|50px]]
 +
| Crystal Space
 +
| [http://trac.crystalspace3d.org/trac/CS Crystal Space Developer Wiki]
 +
| [http://sf.net/projects/crystal Crystal Space on SourceForge.net]
 +
|-
 +
| [[Image:CEL.png|left|50px]]
 +
| [[CEL|Crystal Entity Layer]]
 +
| [http://trac.crystalspace3d.org/trac/cel CEL Developer Wiki]
 +
| [http://sf.net/projects/cel CEL on SourceForge.net]
 +
|-
 +
| [[Image:CrystalCore-compact.png|left|50px]]
 +
| [[Crystal Core]]
 +
| [http://crystalcore.crystalspace3d.org CC Developer Wiki]
 +
| n.a.
 +
|}
-
= Varia =
+
= Summer of Code =
-
* [[MediatorTeam]]
+
Crystal Space has been involved with Summer of Code in 2006 and also in 2007. For 2007 you can find more information [[Soc2007|here]].
-
* [[MediatorNotes]]
+
-
* [[RoadMap]]
+

Current revision

Contents

Contributing

Crystal Space is a big project. We always welcome people to help us improve Crystal Space, and there are a wide variety of talents we can make use of.

  • Coders. Most of Crystal Space consists of C++; the level of knowledge required depends on the part of the SDK.
    • For work the core parts of the engine you should be proficient in C++ with some experience in OpenGL and/or 3D graphics in general.
    • Crystal Space is a big project and many of our sub-projects are not directly related to 3D or even graphics - for example, we have support for audio, physics, joystick input... These parts also usually require a relatively low level of C++ knowledge.
    • We have a custom build system. So if you're good at writing shell we always welcome a hand here.
    • If you're good in other languages, maintaining bindings for that language may be something for you.
  • Coders for our Crystal Core project. This basically involves a lot of work on CEL and also good knowledge on how to use CEL's XML script language.
  • Documentation writers. We have documentation but some parts are lacking and some parts are completely missing. Even if you're just mostly reading the documentation, we always welcome improvements - clarifications, rewordings for readability, expanding some of the API docs...
  • Artists. For our Crystal Core project we need 3D, 2D, sound, and music artists. For Crystal Space itself we need nice levels and demos to show off what it can do, and the occasional test level.
  • Web Designers/Developers. Some aspects of our web site are customized or need custumization (e.g. skins). Maintenance and updates is needed here as well. The web site bug tracker lists things that need to be done.
  • Public Relations. This may not be as obvious but one way you can help contribute to Crystal Space is by doing public relations for us. i.e. tell the world how good you think Crystal Space is. On this page you can find more information on things you can do to help promote Crystal Space.
  • Donate Money. You can also do a monetary donation if you want. We will use this money for a 'good' Crystal Space related goal. In this case for example the new Apricot Open Game project. You can donate here SourceForge Donation Page. If you want to donate money some other way then contact us.

“Getting in”

Contributing to CS is easy:

  • If you have found a bug and fixed it, go ahead and open a new issue on the issue tracker, with your bug attached.
  • The same goes for smaller enhancements and documentation improvements.
  • If you're just curious but don't have anything specific to be done in mind, look at the open tickets on the bug tracker.
  • Usually we'll grant SVN access after a couple of patches were accepted and committed.
  • It's always a good idea to subscribe to the main, dev and cvs mailing lists.
  • If you have some “bigger” idea (write a new plugin, make a bigger enhancement/change) write a mail to the main developers.

Report Bugs

Go to the Bugs page to report bugs in Crystal Space, CEL, or Crystal Core.

Crystal Space View tickets Report new
Crystal Entity Layer View tickets Report new
Crystal Core View tickets Report new
The whole homepage View tickets Report new

Developer's White Board

For all our projects we have a developer wiki which is separate from this site. Crystal Space and CEL also have SourceForge projects. You can find them in the following table:

Crystal Space Crystal Space Developer Wiki Crystal Space on SourceForge.net
Crystal Entity Layer CEL Developer Wiki CEL on SourceForge.net
Crystal Core CC Developer Wiki n.a.

Summer of Code

Crystal Space has been involved with Summer of Code in 2006 and also in 2007. For 2007 you can find more information here.

| Article | Discussion | View source | History |