Contribute¶

Contents

• Contribute
  • You've found a bug?
  • You've found a security vulnerability?
  • You want to propose a feature?
  • You want to help translate ChiliProject?
  • You want to improve the documentation?
  • You want to support other users?
  • You can help triaging issues?
  • You want to contribute code?
  • You want to contribute money?

This project is built and maintained by community volunteers. If you would like to give back to the community, there are several ways to contribute back to the project.

You've found a bug?¶

Opening tickets for bugs you find is a great way to contribute to ChiliProject.

The first step when you think you have found a bug is to look to see if it has already been reported, use the search (at the top right of any page) to that end. If there's already a bug report covering the problem you are encountering, please comment on that ticket instead of opening a new one.

If you can't find a ticket covering the problem you are encountering, please open a new one and try to include the following:

• your ChiliProject version or revision and where you got it from (Examples: tag 1.1.0 from git, Debian package version 1.1.0)
• your Ruby version (Example: 1.8.7)
• your Rails version (Example: 2.3.5)
• your database including version (Example: PostgreSQL 8.2)
• your SCM including version if the problem is related to the SCM integration (Example: svn 1.6.11)
• the error trace if ChiliProject crashed, you'll find it in log/production.log in your chiliproject directory most times.

If you have access to your ChiliProject installation, running the following command in your chiliproject directory will provide most of the required information:

RAILS_ENV=production ruby script/about

or, on Windows:

set RAILS_ENV=production
ruby script\about

You've found a security vulnerability?¶

We're going to great lengths to make sure ChiliProject is secure, but sometimes that isn't enough. If you think you've found a security vulnerability, send a email containing a precise description of the vulnerability to security@chiliproject.org, we'll get in touch with you.

You want to propose a feature?¶

Have a look at existing feature requests to see if anyone has already proposed something similar, open a new feature request if not. Fill in the subject with a short but accurate title, put details in the description, don't hesitate to describe precisely how this feature should behave and try to add what benefits you're expecting from it.

You want to help translate ChiliProject?¶

ChiliProject has translations for a lot of languages, those translations however become incomplete and/or outdated over time. If you've found some part of ChiliProject with English text where there shouldn't be (English is the default for strings that have not yet been translated), try to find the English text in the locale file corresponding to your language, translate it and post the changes in a new bug report. You can find the locale files in the config/locales directory of your ChiliProject installation, the files are in YAML format and named after the IANA country codes, for example de.yml contains the translated strings for the German language.

If you would like to actively and regularly maintain the translation for a particular language, please get in touch with the development team lead. If you want to translate ChiliProject to a new language, please see the translations guide.

You want to improve the documentation?¶

All the documentation on ChiliProject is in the ChiliProject wiki, which is almost fully modifiable by logged in users. If you think you can make improvements to the existing documentation we encourage you to do so, please make sure to fill in the comment section at the bottom of the edit page to make keeping track of changes easier.

You want to support other users?¶

Helping out other users in the Forums and the IRC channel is always useful. Frequent problems or questions should be added to the wiki so they can be found by future users, either to the FAQ if it's a small question or a new page if it's something bigger.

You can help triaging issues?¶

Take a look at new issues, do they contain all the information needed to reproduce the issue? Has anyone tried to reproduce the issue on a test installation of ChiliProject? Does the issue have a patch attached, but no one has reviewed it yet? If the answer to any of these questions is no, you can try to fill in the blanks. Getting details about an issue from the reporter and the community and confirming an issue by trying to reproduce it yourself means the developers can spend more time developing instead of trying to understand what errors users are having.

You want to contribute code?¶

For the impatient: report, confirm, claim, fork, branch, write, test, push.

The short version:

1. Make sure the issue you are working on is reported and confirmed, add a note to the issue to claim your intention to work on it.
2. Fork ChiliProject on GitHub.
3. Create a new branch from master with a descriptive name prefixed by the issue ID (Example: 123-change_background_from_black_to_blue).
4. Make changes according to our Code Standards.
   • Be sure to include tests as necessary.
   • Make sure to not break existing tests.
   • Please try to make sure your code is going to pass a Code Review prior to submitting the patch. If in doubt, just ask.
5. Either upload your branch to GitHub and send a pull request to the ChiliProject repository, or attach a patch to the issue on ChiliProject. If you send a pull request on GitHub, remember to link to the pull request in the issue you create on ChiliProject and to link to the issue on ChiliProject in the pull request on GitHub.
6. Make sure you watch the corresponding issue in case any discussion arises or improvements are needed.

The long version is on the Contribute Code page.

You want to contribute money?¶

Check out the Donate page, currently we are only accepting donations via paypal, hopefully in the near future we will include other methods.

If you need any help, feel free to drop by on IRC or in the Forums.