Contributing

From OpenBlox
Jump to: navigation, search
Other languages:
English • ‎français

You can contribute to OpenBlox in many ways. You can fix mistakes you see while browsing the wiki, and you can improve content or write new content about OpenBlox. If you're a programmer, you can contribute to the game engine or the other tools that are developed as part of the OpenBlox project.

Donation

We accept donations in the form of Bitcoin, Litecoin and PayPal payments. You can find our current addresses at https://openblox.org/donate.asc, signed by, the project lead, John Harris' key. Monetary contributions help keep our servers running, pay for our domain, and internet access, among other things.

Hardware

We also accept hardware donations including, but not limited to the following hardware devices:

  • Rackmount servers
  • Workstation computers
  • Laptop computers
  • 10/100 or gigabit managed ethernet switches
  • Uninterruptible power supplies

Donated hardware does not have to be in working condition, but it would be preferable if we don't have to take our system administrator away from other work to fix devices. Send hardware offers to hardware-donation@openblox.org.

Documentation

Documentation of the OpenBlox game engine and related software is done on the wiki at wiki.openblox.org. To contribute, you only need to create an account. As a measure against spam and vandalism, new accounts cannot upload files, create pages other than talk pages or move pages. Accounts that have existed for more than five days and have more than fifteen contributions are marked as autoconfirmed and can do all these things. If you need help editing the wiki, you can see the MediaWiki help pages or ask on talk pages.

Class documentation is done using the Infobox class, Property, Method and Event templates. You can find usage documentation for each of these templates on its template page.

Translation

We're always looking for translators for the wiki itself, as well as the engine and client. If you wish to translate the wiki, contact mark&openblox.org. Translation of the engine, client and Studio is all done through Qt Linguist. If you need any help with that, contact johnmh&openblox.org.

Development

The OpenBlox source code is hosted at git.openblox.org. You will need the Git version control system installed on your system to contribute. You can choose one of the repositories listed on git.openblox.com and use the git clone command to clone the repository using one of the URLs given in the Clone section. For example, to clone the code repository for the game engine, you could run git clone https://git.openblox.org/libopenblox.git.

This will create a directory containing the source code where you can make changes, stage them and commit them. If you are not familiar with Git, you can see the git tutorial with the command git help tutorial, or, if you are on a system which is not Unix-like, you can see the Git tutorial and the Git User's Manual in a web browser. After making changes, you will need to build OpenBlox to test them. This is done with the make all command after installing the dependencies.

If your changes are nontrivial (you can consider as trivial anything that changes less than twenty lines), you need to add a signed-off-by line to the commit message with the --signoff option of the git commit command. This indicates that you certify the Developer's Certificate of Origin. Once you have commits you would like to submit for review, run git format-patch --to=devel@lists.openblox.org commit. Git will generate a patch for every commit done after (and including) the commit designated by commit, which can be the commit's hash, HEAD~1 for the previous commit, HEAD~2 for the commit before that commit, etc., or origin/master if you want to include all commits added to your local repository that are not in the upstream repository. The command will give you the name of the patch files created. Send these messages as email to devel@lists.openblox.org for review, keeping the subject and message content generated by Git. You can use any mail client, but we recommend you use git send-email (see git help send-email), which on Debian and Fedora you can get from the git-email package. You can add an introductory message with the --compose option, which is likely to be desirable for nontrivial patches.

When you are creating a commit for another user, you can use git commit --author="AUTHOR" to specify the change's author. Each line in commit messages should be 71 characters or less. Commit messages should contain only printable UTF-8 characters. Always use present tense ("What the change does", not "What the change did"). If a commit has multiple authors, for example altered patches, prepend an empty line to your commit message followed by "Co-Authored-By: Name <email>".

Bug tracker

The OpenBlox project hosts a Bugzilla installation at https://bugs.openblox.org/, which is to be used for the OpenBlox engine and related projects.

Git quick guide

For the convenience of contributors, we have a Git quick guide. It includes information useful to contributors with direct repository access, but it isn't of much use to those who don't have push access.