Request new repository in the JCP GitHub organization

This document describes the process of requesting new repository in the Java Community Process (JCP) GtHub organization.

  1. This workspace is dedicated only to store the content related to the JSRs development via JCP Process. Please contact JCP PMO office (pmo@jcp.org) to make sure that your content is sutable for this workspace. Be prepared to show your content.

  2. Please be aware that all repositories created under JCP organization on the GitHub are public, which means that people can freely see the content of the repositories and clone them. Make sure to prepare the following to get the approval to place your repository in this workspace:

    • Approvals from your company’s management & legal to share the project’s content with the public (if applicable)
    • The License under which the content is shared
    • Test GitHub repository with your content:
      • If you are an Oracle employee, please contact pmo@jcp.org for details about setup of such repository.
      • If you are not an Oracle employee you can prepare a repository under your GitHub account
    • Send all this information to the pmo@jcp.org for review.
  3. JCP GitHub Organization Repository Requirements

    • Naming standard

      • The repository name must be all lowercase, and use dashes to indicate a space, and the name must be specific to the project.
      • The repository name must be aligned with the project goal or product it represents.
      • The repository name will go through review by the JCP PMO Team
      • Repositories intending to be samples-only repositories must be named with the -sample(s) suffix.
    • Contain a README.md

      • The repository must include a detailed README.md file with information about the projects intent and clear opportunities for engagement.
      • The README.md file must live in the root directory. The contents of the README.md will be displayed on the project’s Github page. If you need help with the markup please refer to the official GitHub help page.
      • How to contribute section, linking to the CONTRIBUTING.md file (see below).
      • The README.md file will go through review by the JCP PMO team.
    • Contain a LICENSE.md

      • The project should include one of the approved licenses, contained in a LICENSE.md file. If such a license is not applicable for the project it cannot be placed into this workspace.
      • The LICENSE.md file should be placed in the repository’s root location.
      • The LICENSE.md file will go through review by the JCP PMO team.
    • Contain a CONTRIBUTING.md

      • The link to this file is provided automatically by GitHub when user wants to create an issue or pull requests.
      • The CONTRIBUTING.md file should contain detailed instructions on how to contribute to the project.
      • The CONTRIBUTING.md file can either include the overall participation terms or contain a link to the appropriate participation agreement.
      • The CONTRIBUTING.md file will go through review by the JCP PMO team.