ChiliProject is not maintained anymore. Please be advised that there will be no more updates.
We do not recommend that you setup new ChiliProject instances and we urge all existing users to migrate their data to a maintained system, e.g. Redmine. We will provide a migration script later. In the meantime, you can use the instructions by Christian Daehn.
This project is built and maintained by community volunteers. If you would like 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 if it's not 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.0from git, debian package version
- your Ruby version (Example:
- your Rails version (Example:
- your database including version (Example:
- your SCM including version if the problem is related to the SCM integration (Example:
- the error trace if ChiliProject crashed, you'll find it in
chiliprojectdirectory 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
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 mail containing a precise description of the vulnerability to email@example.com, we'll get in touch with you.
You want to propose a feature?¶
Have a look at existing feature requests to see if no one 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, most pages of which logged in users should be able to modify. If you think you can make improvements to the existing documentation, feel free to do so, be 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?¶
The short version:
- Make sure the issue you are working on is reported and confirmed, add a short note to the issue about your intention to work on it to avoid duplicate work,
- Fork ChiliProject on Github,
- Create a new branch from
masterwith a descriptive name prefixed by the issue ID (Example:
- Make changes, be sure to include tests as necessary, make sure no existing tests break (read about the Code Review process for the gory details),
- Eiher upload your branch to Github and send a pull request to the ChiliProject repository, or attach a patch to the issue on ChiliProject,
- 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.