ezQuake Manual: Contributing

How can you contribute to the ezQuake project?

What do we need?

We appreciate any help with tracking down bugs. We release nightly alpha builds for testing purposes and welcome any help with reporting bugs found in them.

We are looking for developers. If you are able to contribute any sort of code that would be usefull for us, send us the .patch files with comments of what you've done and you can easily become a stable member of the development team. Take a look at the Feature requests if you need inspiration of what's needed to be done. We also welcome your own invention in adding new things and improving existing ones.

At the moment we are especially lacking developers interested in OpenGL programming.

ezQuake team is open for new people, don't be afraid to contact us.

What do we offer

Experience from collaborative work in a wide team, help with coding things you want to learn and for the last but not the least: your place in the credits, and all the fame and glory ezQuake developers get!

Where to start

If you need some introduction into Quake and ezQuake source code, check these pages:
Fabien Sanglard's non-blog: Quake Engine code review (1/4)
ezQuake Manual: Code structure

How to contribute

Our source code is hosted on github.com. You will need a git client to download the source codes. For Windows we recommend comman-line tool msysgit. Once you have it issue following command
git clone git@github.com:ezQuake/ezquake-source.git

If you intend to contribute small patches, send them via e-mail to johnnycz at users.sourceforge.net. Use this option only if you are contributing small changes which you are sure need no discussion or adjustments.

If you want to contribute larger changes (many changed files, hundred or more changed lines), consider starting your own fork of ezQuake source code repository on github. It is quite easy and will allow you publishing your changes in advance and discuss them with whole ezQuake team thoroughly. Great feature is pull request which is a very comfortable way to request, discuss and perform merging of your changes into official ezQuake source code branch.

Last update: 17.04.2011 11:11 UTC
ezQDocs

SourceForge.net Logo