The simplest way of contributing xAPI recipes works as follows:
- add an issue to the issue tracker to alert everyone to what you are working on and why
- tag the issue with the version milestone you'd like the patch to be a part of
- make an edit or add a file in this repository, and save it to your own branch. If you prefer, you can fork the whole repository and work in your own repository
- send a pull request once you're done
- the pull request will be discussed at our weekly meeting and either merged, or kept in the queue, depending on whether more work is required
You can do all this through the Github GUI, but you're welcome to use any other git tool you prefer.
If the need arises, particular versions will get their own branches, but until that time, everything is merged into the main branch. Releases will be made after the group has come to an agreement.
- Vocabulary gives the IRIs and definitions for verbs, activity types, etc, as well as for extensions used in the recipes.
- Common Structures outlines common patterns used across different recipes.
As far as possible all entities are the same across recipes and are identified by a version.
These are the currently platform independent documented recipes:
- Logged in
- Logged out
- VLE resource viewed
- Session timeout
- Assignment Graded
- Assignment Submitted
- Attended learning activity
- WiFi associated/Presence
- Library examples(In development branch)