Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

87 lines (61 loc) · 3.55 KB

Contributing to Eclipse Tyrus

Thanks for your interest in this project.

Project description

Eclipse Tyrus is the open source JSR 356 - Java API for WebSocket reference implementation for easy development of WebSocket applications. Eclipse Tyrus is also a Jakarta WebSocket 2.0 compatible implementation.

WebSocket protocol defined by IETF provides bi-directional communication between the server and the remote host. The pros are mainly the ability to communicate both ways, low latency and small communication overhead. Therefore Tyrus and WebSocket in general are suitable for web applications that require sending a huge volume of relatively small messages like online games or market ticker broadcasting.

Goals of Eclipse Tyrus project can be summarized in the following points:

  • Track the Eclipse WebSocket API and provide regular releases of production quality implementations that ships with GlassFish;

  • Provide APIs to extend Tyrus & Build a community of users and developers; and finally

  • Make it easy to build websocket based web services utilising Java and the Java Virtual Machine.

Developer resources

Information regarding source code management, builds, coding standards, and more.

The project maintains the following source code repositories

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

Specifications

This specification project operates under the terms of the Eclipse Foundation Specification process.

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit

Contact

Contact the project developers via the project's "dev" list.