Hello all!
Here a quick reminder to spend your post-lunch coma with us on Skype,
brainstorming on your requirements and ideas for the Internal API Alignment
project!
Join here, the meeting will be from 13:00 15:00.
https://join.skype.com/nTFqPJGccWeI
Cheers,
~Max
--
Maximilian Becker
fon 0 24 05 / 4 08 37 - 0
fax 0 24 05 / 4 08 37 - 59
mail <mailto:mbecker@databay.de> mbecker(a)databay.de
Databay AG
Jens-Otto-Krag-Straße 11
D-52146 Würselen
<http://www.databay.de/> www.databay.de
Betrieblicher
Datenschutzbeauftragter (bDSB)
Für Anfragen den Datenschutz betreffend
bitte <mailto:ds-mbecker@databay.de> ds-mbecker(a)databay.de verwenden.
Sitz/Amtsgericht Aachen HRB:8437 USt-IdNr.: DE 210844202
Vorstand: Ralf Schenk, Dipl.-Ing. Jens Conze, Aresch Yavari, Dipl.Kfm.
Philipp Hermanns
Aufsichtsratsvorsitzender: Wilhelm Dohmen
Dear ILIAS-developers and -admins,
we would like to inform you about the introduction of a new coding style guideline for ILIAS-code [1], why, how and when we want to introduce it and how you will be involved in this process.
The coding style guideline we will introduce is the well known PSR-2 [2] plus some rather minor additions. We believe it to be very valuable for projects to stick to a common style: it is easier to read code with a consistent layout, it is easier to find your way around in code if you aren't distracted from differences in styling and, finally, we all have one rather minor point less to argue about. Currently there already exists a coding style guideline for ILIAS, but it isn't followed consistently. We further believe that the value of coding style guidelines doesn't only apply to single projects, but also to a language community as a whole. If people share a common guideline when writing PHP, the benefits will also apply when switching projects and newcomers to ILIAS won't be distracted by ILIAS specialties in the coding style. To introduce a consistent coding style that also follows standards of the PHP-community, we decided to introduce PSR-2 with some additions.
We intentionally only focussed on directions regarding formatting of code and dismissed questions regarding naming or patterns like "How to name interfaces or classes?" or "When to use early return?". We feel that these require more effort in discussions and want to pick low hanging fruits via this proposal first.
This guideline replaces the one in the development guide [3].
We know that this introduction of a coding style guideline will cause some disruption, among core-developers as well as among devs who maintain patched versions of ILIAS. We still feel that having no implemented guideline is not an option anymore and try to make the move to PSR-2 plus additions as painless as possible. The introduction will benefit us all long-term.
The introduction will proceed in three phases:
Starting in June 2019 every change in a maintained ILIAS-version or the trunk must be made after the coding style in the targeted file(s) is fixed. The style fixes must be made in a single commit with the message "CS fix". The desired changes should be made afterwards and in one or many separate commits. If I would, for example, want to fix a bug in Modules/StudyProgramme/classes/class.ilObjStudyProgrammeGUI.php I would first apply the fix to the coding style to the file, commit it with the message "CS fix", then make the desired changes to fix the issue, and also commit them. Maintainers may also move a complete component in all maintained branches and the trunk to the new style at their own discretion. This will gradually move some parts of all of our branches to the new coding style while maintaining the possibility to find a responsible person via git blame and cherry-picking changes from other branches.
Once the beta-release is ready and branched in October, we will apply the new coding style to the rest of our codebase in all maintained branches and the trunk. This will be done via one big commit per branch. This will break patches, PRs that are open at that point in time and also git blame for parts of the codebase that haven't been modified before. Please be aware that this will happen and reserve time for required actions accordingly.
After this single commit that fixes the rest of our codebase, our CI-server [4] will automatically check if new code respects our coding style guideline. We are looking into the details regarding the necessary measures to ensure the whole ILIAS code base keeps respecting the guideline also in the future. One important elements will be the actions taken by the CI-server if code does not respect the guideline.
To ease the introduction and also maintain the coding style in the long-run, we will supply you with some material:
* A documentation that shows how you could introduce tooling on your dev-machine that automatically maintains the coding style.
* A configuration for PHPStorm for the coding style.
* A shell-script that fixes the coding style for a single file or a directory.
We are exited to make this move with you and look forward to have a consistent style in out codebase. If you have any doubts, questions or suggestions, feel free to contact us at tb(a)lists.ilias.de
Shout out to Nils Theen (@legionth) for pushing this issue. Thanks!
Best regards!
Stephan Winiker
on behalf of the Technical Board of the ILIAS Society
[1] https://github.com/ILIAS-TechnicalBoard/ILIAS/blob/trunk_coding_style/docs/…
[2] https://www.php-fig.org/psr/psr-2/
[3] https://docu.ilias.de/goto_docu_pg_202_42.html
[4] https://travis-ci.com/ILIAS-eLearning/ILIAS
Hello everyone!
Thank you all for participating in the Doodle!
The Skype-Meeting "Requirements Acquisition Workshop" Internal API Alignment
will be held on:
Monday, 27. May 2019, 13:00 15:00 Uhr
Everyone may join in via this link:
<https://join.skype.com/nTFqPJGccWeI> https://join.skype.com/nTFqPJGccWeI
Kind regards,
Maximilian
--
Maximilian Becker
fon 0 24 05 / 4 08 37 - 0
fax 0 24 05 / 4 08 37 - 59
mail <mailto:mbecker@databay.de> mbecker(a)databay.de
Databay AG
Jens-Otto-Krag-Straße 11
D-52146 Würselen
<http://www.databay.de/> www.databay.de
Betrieblicher
Datenschutzbeauftragter (bDSB)
Für Anfragen den Datenschutz betreffend
bitte <mailto:ds-mbecker@databay.de> ds-mbecker(a)databay.de verwenden.
Sitz/Amtsgericht Aachen HRB:8437 USt-IdNr.: DE 210844202
Vorstand: Ralf Schenk, Dipl.-Ing. Jens Conze, Aresch Yavari, Dipl.Kfm.
Philipp Hermanns
Aufsichtsratsvorsitzender: Wilhelm Dohmen
Dear Developers, Tinkerers, Admins!
The Technical Board has contracted Databay and Leifos for a comprehensive
concept on Internal API Alignment. Before we go to work and come up with
something behind closed doors, we would like to hear YOUR requirements,
thoughts and hopes, how you would like to interact with components in ILIAS
in the future.
Itll be a lengthy process to get everything working according to the new
processes and framework, but NOW is when you are asked to voice your
thoughts on the matter. Your input is valuable and maybe you bring up that
aspect that is ideally addressed already in the foundation of the upcoming
developments?
We plan a 2 hour Skype conference and I hope for a lively interactive
discussion, a wild brainstorming!
Sign your times in the doodle so we can meet and hear you:
https://doodle.com/poll/i25sn375wh5peehn
If you cannot make it but still have the million-dollar-plan, send it to me
mbecker(a)databay.de <mailto:mbecker@databay.de> and it will be read to
the conference.
Kind regards,
Maximilian Becker
--
Maximilian Becker
fon 0 24 05 / 4 08 37 - 0
fax 0 24 05 / 4 08 37 - 59
mail <mailto:mbecker@databay.de> mbecker(a)databay.de
Databay AG
Jens-Otto-Krag-Straße 11
D-52146 Würselen
<http://www.databay.de/> www.databay.de
Betrieblicher
Datenschutzbeauftragter (bDSB)
Für Anfragen den Datenschutz betreffend
bitte <mailto:ds-mbecker@databay.de> ds-mbecker(a)databay.de verwenden.
Sitz/Amtsgericht Aachen HRB:8437 USt-IdNr.: DE 210844202
Vorstand: Ralf Schenk, Dipl.-Ing. Jens Conze, Aresch Yavari, Dipl.Kfm.
Philipp Hermanns
Aufsichtsratsvorsitzender: Wilhelm Dohmen
Dear developers/administrators/users,
as announced at the ILIAS development conference in Cologne, the
Technical Board is looking for volunteers interested in founding/joining
a/the ILIAS security group. This is a valuable contribution to the
project and we welcome participants with all backgrounds, so you don’t
have to be a security research specialist (though you of course may be
one). We’re also looking for helpers with strong communication skills,
documentation writers and evangelists.
The group will first be tasked with supporting our security process [1],
i.e. answering to incoming security issues, operating the security
tracker and follwing up on issues. We hope to expand the tasks of the
group in the future to further develop our security process.
Interested people will be invited to a VC meeting (a Doodle link will be
provided) where the security process will be introduced in detail to all
participants and then we’ll see to find that proper role in our team for
you.
Best regards
Michael Jansen
on behalf of the ILIAS e.V. and the Technical Board
[1]
https://docu.ilias.de/goto.php?target=wiki_5307&client_id=docu#ilPageTocA112
Dear developers,
This mail is just a reminder for those of you who are making bugfixes in the ILIAS core project in Mantis.
When you fix and commit a bug, please do not forget to add the „Fixed in version“ date in the Mantis report. This is always the next release of the ILIAS version for which this report has been created. Example: bug has been reported for 5.3.12 and is fixed now; next upcoming 5.3 bug fix release is 5.3.16; Release 5.3.16 has to be added to „Fixed in Version“.
This information is necessary to build a proper change log at https://mantis.ilias.de/changelog_page.php <https://mantis.ilias.de/changelog_page.php>. Bug fixes only appear in the change log when the „Fixed in Version“ data is set. And we always use these reports from Mantis in the release reports at https://docu.ilias.de/goto_docu_lm_1719.html <https://docu.ilias.de/goto_docu_lm_1719.html> (LM „Releases“). Fixed bugs without this data will never appear in these lists!
Unfortunately, Mantis allows only one release to be added. But you can add something like „Fixed for 5.4.x and trunk, too“ to the comment field in Mantis as well. This helps users who want to know more about the current status of a bug (fix).
Thanks for your support and
Kind regards,
Matthias
* * * * *
Matthias Kunkel
ILIAS-Produktmanager
Geschäftsführer ILIAS open source e-Learning e.V.
Geschäftsstelle:
Ebertplatz 14-16 • D-50668 Köln
www.ilias.de <http://www.ilias.de/>
verein(a)ilias.de <mailto:verein@ilias.de>
* * * * *
ILIAS-Konferenz 2019
Am 26. und 27. September treffen sich ILIAS-Anwender und E-Learning-
Interessierte zur 18. ILIAS-Konferenz bei der DGUV in Dresden. Halten Sie
sich den Termin frei! Mehr Infos in Kürze unter www.ilias-conference.org <http://www.ilias-conference.org/>.
* * * * *
Sind Sie schon Mitglied?
Der Verein ILIAS open source e-Learning e.V. ist Herausgeber und Heimat
der ILIAS-Software. Als Mitglied unterstützen Sie unsere Arbeit und sichern
die Nachhaltigkeit der Softwareentwicklung: http://verein.ilias.de
* * * * *
Diese E-Mail und ihre Anlagen können vertrauliche und / oder rechtlich
geschützte Informationen enthalten. Wenn Sie nicht der richtige Adressat
sind oder diese E-Mail irrtümlich erhalten haben, informieren Sie mich bitte
und löschen diese E-Mail.
Dear all,
On our Jour Fixe today we decided to publish new bug fix releases for all three maintained versions on next Thursday, May 09, 2019.
If you want to have your bug fixes in these new releases, please commit them to the related branches until Thursday morning.
Kind regards,
Matthias Kunkel
* * * * *
Matthias Kunkel
ILIAS Product Manager
General Manager ILIAS open source e-Learning e.V.
Office:
Ebertplatz 14-16 • D-50668 Koeln
www.ilias.de <http://www.ilias.de/>
verein(a)ilias.de <mailto:verein@ilias.de>
* * * * *
Dear all
As announced, we would like to invite you to participate in the Doodle for
the second developer workshop concerning the "View" mechanism:
https://doodle.com/poll/w8987yvbvfbz2tk3
Fabian will discuss with you in detail how he understands the mechanism,
combining Global Screen Service and NavigationContext Service.
Afterwards we are very interested in your opinions, want to explore
stumbling blocks and work out solutions and/or a further procedure.
The following questions will be important:
- Will the interaction between View/Screen and NavigationContext work
from your point of view?
- From your point of view, are there any other views/screens that have
not yet been included in the feature request? What about those that have
not yet been classified (LTI view and learning module SCORM (setting: main
menu inactive))?
- Which views/screens should be maintained in ILIAS 6.0?
We are happy if you take a closer look into our feature request (check
https://docu.ilias.de/goto_docu_wiki_wpage_5900_1357.html) until the
workshop and would be happy about a discussion :-)
Best regards
Fabian and Katharina
--
*Katharina Burkhardt*
ILIAS Community Manager
Project Manager
*Team Core 1*
phone +41 31 972 52 30
support-core1(a)studer-raimann.ch
*studer + raimann ag*
IT- and Learning-Solutions
Farbweg 9
CH-3400 Burgdorf
main +41 31 972 52 22
studer-raimann.ch
--
Wanna know more? Contact us directly or find information online:
Corporate
Website studer-raimann.ch <https://studer-raimann.ch> | Product Website
ilias.ch <https://ilias.ch>
Facebook
<https://www.facebook.com/studer.raimann> | XING
<https://www.xing.com/companies/studer+raimannag> | LinkedIn
<https://www.linkedin.com/company/studer-raimann-ag>