Contributing to Teambox

If you want to include your code in the general Teambox release, follow these steps:

1. Get Teambox running locally, following the installation guide
2. Get an account at Github and fork the project teambox.
3. Develop your feature or fix, writing tests where necessary.
4. Organize your commits and rebase frequently. A good guide about this.
5. In your commits, explain why you did something, not how.
6. Rebase your copy to the latest master branch from Teambox-2. Make sure it applies cleanly.
7. Send a pull request from Github.

Please read this article about contributing to Merb for best practices.

Coding style

• Use two spaces for indentation.
• Use helpers intensively to keep HAML views short and readable.
• Write Cucumber tests whenever possible to test your feature.
• Write specs for unit tests.
• Clearness over cleverness. It’s better to write a simple, readable method.
• Avoid long methods. Break them into smaller ones.
• Write fat models, skinny controllers.
• Always write localized strings using Rails i18n.
• If you add a localized string, let us know so we translate it to other languages.

Translations

If you would like to see Teambox in your own language, contribute with translations.