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 5 (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 4 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 field (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 4 Toshi MARUYAMA
* your ChiliProject version, or the revision if you're using repository code (Example: @1.1.0@)
15 4 Toshi MARUYAMA
* your ruby version (Example: @1.8.7@)
16 4 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 4 Toshi MARUYAMA
We're going to great lengths to make sure ChiliProject is secure, but sometimes that isn't enough to make it secure. If you think you've found a security vulnerability, send a mail containing the 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 5 Toshi MARUYAMA
ChiliProject has translations for a lot of languages, those however become incomplete and/or outdated over time. If you've found some part of ChiliProject with english text (the default) where there shouldn't be, 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.
35 5 Toshi MARUYAMA
36 5 Toshi MARUYAMA
If you would like to actively and refularly 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 *TODO* guide.
37 5 Toshi MARUYAMA
38 4 Toshi MARUYAMA
39 1
h2. Code Related
40 1
41 3 Toshi MARUYAMA
These require a familiarity with "Ruby on Rails":http://rubyonrails.org/ development. If you are still new to Rails, Community members can help you if you get stuck with something or have any other questions.
42 1
43 3 Toshi MARUYAMA
You will need to download a copy of the current development code. The official code repository is hosted on Github at https://github.com/chiliproject/chiliproject.
44 1
45 3 Toshi MARUYAMA
Any questions can be asked in the "Forums":/project/chiliproject/boards or on [[IRC]].
46 1
47 1
Patches to fix bugs or add new features are always appreciated. If you are going to work on a specific issue, make a note in the issue details so the developers will know what you're working on.
48 1
49 1
h3. Contributing code:
50 1
51 2 Toshi MARUYAMA
# Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
52 2 Toshi MARUYAMA
#* Patches are not accepted for stable release branches. All code must start in master and then be merged into other branches.
53 2 Toshi MARUYAMA
# Check out the issues list to make sure someone already hasn't requested it and/or contributed it.
54 2 Toshi MARUYAMA
# Fork the project on Github.
55 2 Toshi MARUYAMA
# Start a feature/bugfix branch, with a good descriptive branch name. Using the issue number as the prefix is a great idea (e.g. @git checkout -b 1234-add-new-feature@).
56 1
# Make sure all the existing tests pass. You can check the current build statuses on the Continuous Integration server *TODO*
57 2 Toshi MARUYAMA
# Commit and push until you are happy with your contribution.
58 1
# Make sure to add tests for the feature/bugfix. This is important so the feature/bugfix doesn't break in a future version unintentionally.
59 2 Toshi MARUYAMA
#* We only accept patches with extensive test coverage.
60 2 Toshi MARUYAMA
# Create a pull request on Github and post a comment to the issue here.
61 1
# Ask for feedback from users and developers. Users will want to to apply the patch and try out the new functionality.  Developers will want to do a code review and run all of the tests.
62 2 Toshi MARUYAMA
# Discuss any changes that are proposed and push updates as needed until the code is integrated.
63 1
64 1
h2. Issue triage
65 1
66 2 Toshi MARUYAMA
Sometimes issues are reported without all the information needed by a developer. Getting the details of the bug or feature from the reporter and the community helps everyone understand what is needed on the issue. If you can try to reproduce the bug in your own ChiliProject adding a note about your version and the exact steps you took are extremely useful.
67 1
68 1
Also some issues will have patches attached to them with proposed fixes.  Reviewing and updating these patches is very helpful. 
69 1
70 1
h2. User support
71 1
72 3 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]] (either to the [[FAQ]] or a new page) so they can be found by future users.
73 1
74 1
h2. Localization and translation
75 1
76 1
Translations are kept up-to-date alongside the code development. You could provide updates to the translations or propose new translations by opening a new issue.