Updating webintents.org

Introduction

This page is a guide to how you can help and contribute to the Web Intents project.

All the code for this project is open and hosted on Github.

We gladly accept and encourage patches to the project. You can contribute by forking the project. and then following the guides below for the area that you want to edit.

Updating the Shim

The shim is the implementation of webintents for browsers that don't natively support the API.

The client code resides at https://github.com/PaulKinlan/WebIntents/tree/master/src.

The service code is the code that displays the picker and routes the messages between apps is located at https://github.com/PaulKinlan/WebIntents/tree/master/server/webintents/static.

Updating Intents

Each intent supported under the webintents.org prefix lives in the root directory. Updating intents is easy, and is just a case of forking the project and issuing a "pull request" to get the changes reviewed and merged into the project.

The code for each intent is located in https://github.com/PaulKinlan/WebIntents/tree/master/server/webintents/pages and has no file extension.

Each intent page MUST include the textual documentation for the intent AND code examples for invokation, and service handling. It should also include documentation and code examples for each major data type.

Adding Intents

Each intent supported under the webintents.org prefix lives in the root directory.

Adding new intents is procedurally little more complicated. First fork the project, add the intent documentation as described below , issue a pull request and then send the proposal for discussion of a new intent to the webintents-discuss group.

Once there is consensus, the pull request will be merged in to the main project.

The code for each intent is located in https://github.com/PaulKinlan/WebIntents/tree/master/server/webintents/pages and has no file extension.

Each intent page MUST include the textual documentation for the intent AND code examples for invokation, and service handling. It should also include documentation and code examples for each major data type.