Starting a New Project

You can share your idea for a new Project by starting a Discussion here.

Organization Admins can execute the below procedure to create new Project within the Sonatype Open Source Community.

New Project Proposal

Prerequisites

• Ensure you have defined a clear purpose for the new project
• Maintainers of the project must have previously contributed to another Sonatype Open Source Project

Why?

Having contributed previously means you’ll have signed our CLA and understand our Community workflows.

Creating the Project

• Create a new GitHub Repository in the Sonatype Community GitHub Organization using the Community Project Template as the template repository
• See our GitHub Repository Configuration Standards

Heads up!

This will cause a number of default files to be placed into your new repository. It will also automatically inherit a number of Organization defined files that you do not need to redefine in your project.

External Project Contributions

External contributors may propose an existing repository for migration into the Sonatype Open Source Community. Follow these steps to accept and onboard the repository:

1. Proposal Submission

• The external contributor should initiate a Project Proposal Discussion.
• Include the following details in the discussion:
  • Public Repository URL
  • A summary of the project’s purpose and goals
  • Any existing contributors who intend to transition as maintainers

2. Initial Review

• Ensure the repository aligns with the Community’s goals and standards.
• Confirm that the repository has an open-source license compatible with the Sonatype Open Source Community licensing policy.
• Assess the project’s activity level, community engagement, and quality of documentation.

3. Feedback Period

• Allow a period for community members and Organization Admins to review and provide feedback on the proposal.
• A thorough review must be performed by Sonatype’s legal team.
• Address any concerns or required changes before proceeding.

4. Repository Transfer

Once the proposal is approved, the repository must be transferred to the Sonatype Community GitHub Organization.

The transfer process includes:

• Coordinating with the repository owner to initiate the transfer.
• Updating any necessary repository settings to align with GitHub Repository Configuration Standards.

5. Assign Roles and Responsibilities

• Ensure that proposed maintainers meet the Maintainer Requirements.
• Assign the necessary roles and permissions to maintainers and contributors.
• Update the repository’s Code Owners and the respective GitHub Team.

6. Announce and Promote

• Publicly announce the inclusion of the project in the Community through appropriate channels.
• Update the Community Project List to reflect the new addition.