• Open Source e-Learning

Breadcrumb Navigation

Icon Wiki

ILIAS Community FAQ

Frequently Asked Questions about ILIAS development and how to participate

Tabs

Questions

This page is work in progress

1 Help

1.1 Who can and should I address if I need help?

ILIAS Forums
  • If you have any questions how to setup and use ILIAS, our forums offer a free and open community discussion. The forums are not intended to be used for reporting bugs or security issues. (See next topics in this FAQ)
  • List of ILIAS Forums
Product Manager/Managing Director
  • If you have questions related to the ILIAS community and its processes in general, contact our product manager and managing director of the ILIAS society.
  • Product Manager/Managing Director: Kunkel, Matthias [mkunkel]
Component Maintainers
  • Please contact one of our maintainers, when you plan to develop a new or modify an existing feature.
  • List of Maintainers
Service Providers

2 Bugs

2.1 How do I report a bug?

Please report any bugs in our ILIAS bug tracker. If you do not already have one, create an account first. More detailed information on how to report bugs can be found here (german only). Please do not report any security relevant issues in the bug tracker (see next FAQ chapter).

2.2 Can I vote on bugs?

Members of the ILIAS society can vote on bugs to influence their priority. High priority bugs should be tackled first by developers. More details can be found here.

2.3 How can I schedule a bug discussion for a Jour Fixe meeting?

If you think the ILIAS core team should discuss a bug, e.g. because there are open conceptual issues or reporter and developer do not agree on any conclusions, you can schedule a bug report for a Jour Fixe meeting.
  • To schedule a bug report for the meeting you MUST set its status to "Needs JF Decision".
  • A comment in the report should address the Jour Fixe directly and present alternative solutions.
  • If possible, the product manager may decide whether an issue is a bug or not beforehand.
  • The product manager estimates the time required per bug report and assigns a time slot for discussion (10 or 20 minutes) accordingly.
You may also contact the product manager (Kunkel, Matthias [mkunkel]) directly, if you would like to schedule a bug report discussion for a specific Jour Fixe and participate in the meeting.

3 Security Issues

3.1 How should I report a security issue?

Please make sure to understand, that treating security issues confidentially is required to keep ILIAS installations as safe as possible until the issue is fixed.

Please write an email to security@lists.ilias.de about your discovery, containing a description of the issue with the scenario in which the problem is triggered and a description of its implications. Do not file an issue in the bugtracker!

You will get an answer from a member of ILIAS society, maybe containing further questions about the issue.

3.2 Where should I publish my fix of a security issue?

We are delighted when solutions are offered together with the initial report. Please be aware, however, that our repository in GitHub is also open to the general public: commits, commit-messages and pull-requests can be viewed by anyone. It is therefore also better in this case to get in touch with security@lists.ilias.de in order to discuss further steps with us.

3.3 How do I receive security update notifications?

Please subscribe to our admin mailing list (ilias-admins@lists.ilias.de) to get notifications about security updates, updates in general and announcements for ILIAS server administrators.

4 Feature Changes

4.1 What are the differences between a core development, a plugin and a patch?

...

4.2 How can I suggest a new feature or a feature modification?

Follow the instructions on this page to create a new feature wiki entry. We have introduced a new template for Creating A New Feature Page. To foster a final acceptance of your feature, you will need to schedule a feature for an upcoming Jour Fixe meeting.

4.3 What are feature workshops and Jour Fixe meetings?

The Jour Fixe meeting is the key instrument for decision making in the development process. On the meeting, new features, selected bugs, pull requests and general development topics are discussed. Product manager and component maintainer finally decide upon the acceptance of a feature, after considering the opinion of the participating developers and users. The meeting takes place every two weeks in the ILIAS headquarters in Cologne. The meeting is open for everyone. It is also possible to participate at the meeting virtually (see information at Jour Fixe agenda and minutes) .

Feature workshops are similar to Jour Fixe meetings, except that they only discuss distinct features and are scheduled on demand. To enable acceptance of features for a release at least the product manager and the responsible component maintainer need to participate. Four types of workshop format exist:
  • 1 hour virtual conference
  • 2 hour virtual conference
  • half day meeting
  • full day meeting
Upcoming Jour Fixe meetings and feature workshops will be announced on the front page of the feature wiki. Alle minutes will be published here.

4.4 How can I schedule a feature for a Jour Fixe meeting?

To schedule a feature for the Jour Fixe meeting your feature wiki page should meet the following criteria. If your proposal is conceptually incomplete you may consider to schedule a feature workshop instead.
  • The proposal MUST outline the problem the proposal tries to solve.
  • The proposal SHOULD contain a brief conceptual summary of the proposal.
  • The proposal MUST indicate the current/future maintainer of the feature.
  • The feature proposal SHOULD be conceptually complete. It should not leave any conceptual issues open. It SHOULD be possible to make a final decision on the proposal (yes/no, selecting one of multiple alternatives).
  • The proposal SHOULD contain relevant technical information provided by the maintainer (dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues).
  • The description SHOULD list all views (screens) of ILIAS that are to be modified, removed, or introduced.
  • For each view the description SHOULD list all user interface elements that are newly introduced, modified or removed. The description SHOULD use the terminology of the kitchen sink, if possible (Button, Glyph, etc.).
  • For each element their textual appearance (labels of buttons, headings, etc.) SHOULD be provided and for interactive elements their behaviour SHOULD be described (what happens if a button is pressed).
  • To support the understanding of the feature screen mock-ups MAY be added.
  • If new user interface elements should be introduced a separate feature wiki entry for the new UI elements MUST be provided, according to the kitchen sink template.
Now please fillout the form "Suggestions for Jour Fixe Agenda" up to one week before the meeting and provide the following information:
  • Your name
  • Envisaged date of Jour Fixe meeting (selection list)
  • URL to feature wiki entry
  • Slot length (15 or 30 minutes)
  • Name of presenter (the person should be able to answer all non-technical questions related to the feature request)
  • Name of responsible maintainer (the maintainer has to participate in the meeting, too)
Dates for upcoming Jour Fixe meetings can also be found on the front page of the feature wiki.

4.5 How can I schedule a feature workhop?

To schedule a feature workshop your feature wiki page should meet the following criteria.
  • The proposal MUST outline the problem the proposal tries to solve.
  • The proposal SHOULD contain a brief conceptual summary of the proposal.
  • The proposal MUST indicate the current/future maintainer of the feature.
Now apply for a workshop to clarify the concept and prepare a promising feature request. An input form will be provided to give in the necessary information:
  • Your name
  • Proposed date of meeting
  • Proposed location
  • URL to feature wiki entry
  • Workshop format (1 hour VC, 2 hour VC, half day meeting, full day meeting)
  • Name of presenter (the person should be able to answer all non-technical questions related to the feature request)
  • Name of responsible maintainer (the maintainer has to participate in the meeting, too)

4.6 How do I find the responsible maintainer for a feature?

You will find a list of all ILIAS maintainers here. The first maintainers are the ones to be adressed for new feature developments. If you are unsure which component is related to your request contact our product manager (Kunkel, Matthias [mkunkel]). You may also ask the ILIAS service provider of your choice.

4.7 Where do I get information on user interface elements and the kitchen sink?

General information on the kitchen sink project can be found here. From ILIAS 5.2 onwards ILIAS will offer a documentation of implemented user interface elements in the ILIAS administration, see KS: Integration in Layout and Styles. If you have any question you may contact Amstutz, Timon [amstutz].

4.8 When will new features be released officially?

5 General Development Issues

5.1 How can I participate in the ILIAS development?

5.2 How can I contribute code?

Most of the ILIAS code is written by code maintainers who committed themselves to provide long term maintenance for their components and features. If you are not a maintainer you can provide code contributions under the following rules.

5.3 How do I become a maintainer?

5.4 How can I schedule a general development discussion for the Jour Fixe?

5.5 What is the ILIAS development conference and how can I participate?

6 Sources of Information

6.1 What general source of information do you have?

6.2 What kind of mailing lists do you have?

Mailing lists for developers, administrators and for reporting security issues can be found here.

Last edited: 06. Mar 2017, 12:21, Killing, Alexander [alex]


No comment has been posted yet.

Search (Block)

Wiki Functions (Block)

Info

Recent Changes