Developers Center / Repository

The Nitro development team uses the Darcs, distributed version control system to organize and maintain the project's source code and resources. If you want to participate in Nitro's development you have to install Darcs on your workstation.

You can check out the latest development version (Glycerin) with:

darcs get --partial http://repo.nitroproject.org

You can browse the source files in the repo or the latest changes.

As an extra convienience we provide gems created from the repository code.

Creating a patch

Before working on you patch, make sure that you have the latest version of the code. Go to your local directory and give:

darcs pull

You can go on and implemented your changes (while following the project's coding conventions). Make sure that your change does not break the the test cases. If you have added files or directories, you have to add them to your repository:

darcs add path/to/myfile
darcs add -r path/to/mydir

Now you have to record your changes with:

darcs record --all

When you are ready with your changes it is time to create your patch bundle:

darcs send -o bundle

The bundle file contains your changes. You can post this file to the fora along with a complete description of your changes. The maintainer will verify the patch and consider it for inclusion to the master repository at http://repo.nitroproject.org.

Please keep in mind that it is preferable to submit multiple atomic patches (using multiple darcs record commands) than one monolithic patch.

Coding conventions

  • Use two spaces (no tabs) for identing
  • Try to make your lines of code shorter than 64 chars wide. But do not go out of the way to enforce this rule, ie a few longer lines are acceptable
  • MyClass.my_method(my_arg), not my_method( my_arg ) or my_method my_arg
  • Always use " (double quote), not ' (single quote) for strings.
  • Follow the conventions you see in the source already
.