Standard Files

This page outlines a set of required standard files and their contentst that each Project must adhere to.

If you created your GitHub Repository from our Community Template, these files will be created in your repository - you’ll just need to amend content as directed below.

There are a number of files you might think need creating that are not in the Template - see Organization Files.

Files YOU should create Heading self-link

Code Owners Heading self-link

This file must be named CODEOWNERS and be in the .github folder at the root of your project.

Every repository must define who owns it.

Here are some groups you can reference if appropriate:

Template files from the Community Project Template Heading self-link

Contributing Heading self-link

This file must be named CONTRIBUTING.md and be in the root of your project.

This file contains project-specific information aiding others in providing contributions to the project. We recommend using the template and expanding to include your project specific information such as:

• Development Guidelines
• Coding Conventions
• How to test and testing expectations

License Heading self-link

This file must be named LICENSE and be in the root of your project.

This file contains the Open Source license applicable to this project. You can just copy the license from the template repository.

The approved license for Sonatype Community Projects is Apache-2.0.

Readme Heading self-link

This file must be named README.md and be in the root of your project.

This is your projects “shop-window”. We’ve provided a boilerplate template for you. Use this to introduce the project, define it’s purpose, explain how to use it etc…

You should not repeat information contained in other documentation files (such as Contributing), but you should link to other documentation files.

There must be a section The Fine Print at the end of the file as per the template.

Organization Defined Files Heading self-link

The following files are defined at the GitHub Organization level (in this repository) and you DO NOT need to copy or reproduce them in your project.

Code of Conduct Heading self-link

This file defines our conduct to define community standards, signal a welcoming and inclusive project, and outline procedures for handling abuse.

Security Policy Heading self-link

Provides instructions for how to report a security vulnerability in your project by adding a security policy to your repository.