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.

Contribute

Version 18 (Toshi MARUYAMA, 2013-07-03 04:44 am)

1 1
h1. Contribute
2 1
3 1
{{>toc}}
4 1
5 1
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.
6 1
7 4 Toshi MARUYAMA
h2. You've found a bug?
8 4 Toshi MARUYAMA
9 4 Toshi MARUYAMA
Opening tickets for bugs you find is a great way to contribute to ChiliProject.
10 4 Toshi MARUYAMA
11 12 Toshi MARUYAMA
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.
12 4 Toshi MARUYAMA
13 4 Toshi MARUYAMA
If you can't find a ticket covering the problem you are encountering, please open a new one and try to include the following:
14 16 Toshi MARUYAMA
* your ChiliProject version or revision and where you got it from (Examples: tag @1.1.0@ from git, Debian package version @1.1.0@)
15 8 Toshi MARUYAMA
* your Ruby version (Example: @1.8.7@)
16 8 Toshi MARUYAMA
* your Rails version (Example: @2.3.5@)
17 4 Toshi MARUYAMA
* your database including version (Example: @PostgreSQL 8.2@)
18 4 Toshi MARUYAMA
* your SCM including version if the problem is related to the SCM integration (Example: @svn 1.6.11@)
19 4 Toshi MARUYAMA
* the error trace if ChiliProject crashed, you'll find it in @log/production.log@ in your @chiliproject@ directory most times.
20 4 Toshi MARUYAMA
21 4 Toshi MARUYAMA
If you have access to your ChiliProject installation, running the following command in your @chiliproject@ directory will provide most of the required information:
22 4 Toshi MARUYAMA
<pre>RAILS_ENV=production ruby script/about</pre>
23 4 Toshi MARUYAMA
24 4 Toshi MARUYAMA
h2. You've found a security vulnerability?
25 4 Toshi MARUYAMA
26 12 Toshi MARUYAMA
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 security@chiliproject.org, we'll get in touch with you.
27 4 Toshi MARUYAMA
28 5 Toshi MARUYAMA
h2. You want to propose a feature?
29 5 Toshi MARUYAMA
30 5 Toshi MARUYAMA
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.
31 5 Toshi MARUYAMA
32 5 Toshi MARUYAMA
h2. You want to help translate ChiliProject?
33 5 Toshi MARUYAMA
34 16 Toshi MARUYAMA
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":/projects/chiliproject/issues/new?issue[category_id]=9. You can find the locale files in the @config/locales@ directory of your ChiliProject installation, the files are in "YAML":http://en.wikipedia.org/wiki/YAML format and named after the "IANA country codes":http://www.iana.org/assignments/language-subtag-registry, for example @de.yml@ contains the translated strings for the German language.
35 5 Toshi MARUYAMA
36 12 Toshi MARUYAMA
If you would like to actively and regularly maintain the translation for a particular language, please get in touch with the [[Teams#Development-Team|development team]] lead. If you want to translate ChiliProject to a new language, please see the [[Contribute Translations|translations guide]].
37 5 Toshi MARUYAMA
38 6 Toshi MARUYAMA
h2. You want to improve the documentation?
39 6 Toshi MARUYAMA
40 17 Toshi MARUYAMA
All the documentation on ChiliProject is in the [[chiliproject:|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.
41 4 Toshi MARUYAMA
42 7 Toshi MARUYAMA
h2. You want to support other users?
43 7 Toshi MARUYAMA
44 12 Toshi MARUYAMA
Helping out other users in the "Forums":/project/chiliproject/boards and the [[IRC|IRC channel]] is always useful. Frequent problems or questions should be added to the [[chiliproject:|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.
45 7 Toshi MARUYAMA
46 7 Toshi MARUYAMA
h2. You can help triaging issues?
47 7 Toshi MARUYAMA
48 12 Toshi MARUYAMA
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.
49 1
50 1
h2. You want to contribute code?
51 1
52 17 Toshi MARUYAMA
For the impatient: "report":/projects/chiliproject/issues/new, confirm, claim, "fork":https://github.com/chiliproject/chiliproject, branch, [[Code Standards|write]], [[Code Review|test]], push.
53 17 Toshi MARUYAMA
54 1
The short version:
55 10 Toshi MARUYAMA
56 18 Toshi MARUYAMA
# 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.
57 18 Toshi MARUYAMA
# Fork "ChiliProject on GitHub":https://github.com/chiliproject/chiliproject.
58 18 Toshi MARUYAMA
# Create a new branch from @master@ with a descriptive name prefixed by the issue ID (Example: @123-change_background_from_black_to_blue@).
59 18 Toshi MARUYAMA
# Make changes according to our [[Code Standards]].
60 18 Toshi MARUYAMA
#* Be sure to include tests as necessary.
61 18 Toshi MARUYAMA
#* Make sure to not break existing tests.
62 18 Toshi MARUYAMA
#* Please try to make sure your code is going to pass a [[Code Review]] prior to submitting the patch. If in doubt, just ask.
63 18 Toshi MARUYAMA
# Either upload your branch to GitHub and send a pull request to the ChiliProject repository, or attach a patch to the issue on project:chiliproject.
64 10 Toshi MARUYAMA
# Make sure you watch the corresponding issue in case any discussion arises or improvements are needed.
65 1
66 9 Toshi MARUYAMA
The long version is on the [[Contribute Code]] page.
67 1
68 9 Toshi MARUYAMA
If you need any help, feel free to drop by on [[IRC]] or in the "Forums":/project/chiliproject/boards.