Skip to main content
  • Edit my account
  • Manage Cookies

Specification Repository Guidelines

Content

Introduction

GitHub Organizations

The following GitHub Organizations are used by the Jakarta EE Working Group:

Specification Project Repository Naming

All repositories in the jakartaee GitHub organization SHOULD begin with the short name of the related specification. The goal of this is keep the jakartaee organization clean with a clear mapping to the specifications as they are published on https://jakarta.ee/specifications/

For example, a specification project will typically have two repositories. One for the specification, which contains the specification document as well as the API artifact(s). And one for the Test Compatibility Kit (TCK). The following naming standard would be used for these two repositories:

As noted above, separate repositories for API and TCK is the typical layout. Specification projects are free to organize their specification, API and TCK how they see fit as long as all repositories start with the short name of the related specification.

Specification Project Repository Ownership

All repositories owned by Specification Projects must be in the jakartaee organization and meet very high implementation-neutrality standards.

Repositories that contain or are tied to implementations should not be owned or developed by Specification Projects. This includes not just implementation code, but demos, examples or tutorials that create dependencies on implementations. Repositories that allow dependencies from any implementation, such as examples with profiles for specific implementations, are not exempt. All such repositories should be owned by separate projects dedicated to managing these assets.

Back to the top