Contributing

Introduction

As an open-source project, the Readium Foundation welcomes contributions from everyone - from individuals, groups and corporations. The best way to get started with Readium is to read through the introductory materials on this site, subscribe to the mailing list and, of course, get the source code and start spelunking through it.

An important note to bear in mind is that YOU are the Readium team. Readium has no “dedicated team”. Other than a consultant or two and a couple of part-time employees, everything in Readium is done by the Readium contributors - some employed by Readium Foundation members, some simply individual contributors.

Contributing as a developers

The Navigation bar contains a Development entry that leads to an overview of each project, with links to the Github repositories where you’ll find the Readium open-source codebase.

Before contributing to the different projects with your Pull Requests, make sure you’ve signed and sent the Readium ICLA (for Individual Contributor License Agreement).

Project Communication

Mailing List

There is an active mailing list for the Readium projects. To join, simply send mail to Ric Wright, requesting access. Alternatively, visit the Google Readium mailing-list page (where you can also browse the archives) and request access.

The Weekly Meetings

There are two regular Readium Meetings each week:

  • Readium Engineering: Wednesdays at 15.30h UTC (summer) / 16.30h UTC (winter),
  • Readium Triage/Planning: Thursdays at 16.00h UTC (summer) / 17.00h UTC (winter).

Both meetings are hosted in GoToMeeting with the same call-in info:

  • Access Code: 915-053-453

  • On the web, click here or call in by phone:

Country Phone Number
Belgium +32 (0) 28 08 4342
Canada +1 (647) 497-9371
Denmark +45 (0) 69 91 89 21
Finland +358 (0) 942 41 5770
France +33 (0) 182 880 462
Germany +49 (0) 811 8899 6925
Ireland +353 (0) 19 030 050
Italy +39 0 693 38 75 50
Netherlands +31 (0) 208 080 208
Norway +47 21 54 82 21
Spain +34 911 82 9890
Sweden +46 (0) 852 500 179
Switzerland +41 (0) 435 0167 65
United Kingdom +44 20 3657 6776
United States +1 (213) 493-0619


Note!

  • Use your microphone and speakers (VoIP) - a headset is recommended.
  • Please mute your phone if you are not talkiing to minimize interference.

An invitation to each meeting and a separate agenda for each meeting and all the login and call-in info is sent out to the readium-dev mailing list each week.

Slack - Real-time Chat

The Readium Dev group uses Slack for real-time chats.

Head here to get an invite: http://readium-slack.herokuapp.com

The actual Readium chat room is here: https://readium.slack.com

(several channels in there, including “general”, “readium-2”, etc.)

Face to Face Meetings

Periodically, we try to arrange a face-to-face meeting of the developers and contributors. These usually but not always coicide with Readium membership meetings and/or major eBook conferences like Book Expo America, or TPAC.

Meeting Archives

The agenda and notes from all the meetings are archived in the Readium Google doc tree. Access to all the archives can be found here.

The Readium-Engineering Meeting

The Readium-Engineering meeting is focused on the current development initiatives. This is the meeting most likely to be of interest to new contributors.

The Triage/Planning Meeting

The Thursday meeting varies in its content, but tends to be broader in scope than the main engineering meetings. Sometimes if focuses on reviewing the open issues or some particular topic. Other times, the meeting focuses on planning for one or more facets of the project over the near or medium term. Longer term planning tends to be held at the membership and board level.