Skip to content

Template_README.md

Latest commit

 

History

History
103 lines (72 loc) · 4.01 KB

Template_README.md

File metadata and controls

103 lines (72 loc) · 4.01 KB

README

The is a README template for CNCF projects. Please start by renaming this to README.md and deleting everything up to and including the "template begins here" comment in this markdown file.

This is a template document for CNCF projects that requires editing before it is ready to use. Read the markdown comments, <!-- COMMENT -->, for additional guidance. The raw markdown uses TODO to identify areas that require customization. Replace [TODO: PROJECTNAME] with the name of your project.

Welcome to the [TODO:Projectname] Project!

[TODO: PROJECTNAME] is a [TODO: Type of Tool] that [TODO: Functions it performs]. [TODO: Reasons why these are needed and valuable]. [TODO: Implementation, strategy and architecture].

[TODO: Additional paragraph describing your project (optional)]

[TODO: PROJECTNAME] is hosted by the Cloud Native Computing Foundation (CNCF).

Getting Started

Contributing

Our project welcomes contributions from any member of our community. To get started contributing, please see our [Contributor Guide](TODO: Link to CONTRIBUTING.md).

Also please familiarize yourself with the Code of Conduct and Developer Certificate of Origin before contributing. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

Scope

In Scope

[TODO: PROJECTNAME] is intended to [TODO: Core functionality]. As such, the project will implement or has implemented:

  • [TODO: High-level Item 1]
  • [TODO: High-level Item 2]
  • [TODO: High-level Item 3]

Out of Scope

[TODO: PROJECTNAME] will be used in a cloud native environment with other tools. The following specific functionality will therefore not be incorporated:

  • [TODO: Excluded function 1]
  • [TODO: Excluded function 2]

[TODO: PROJECTNAME] implements [TODO: List of major features, existing or planned], through [TODO: Implementation requirements/language/architecture/etc.]. It will not cover [TODO: short list of excluded items]

Communications

[TODO: Details (with links) to meetings, mailing lists, Slack, and any other communication channels]

  • User Mailing List:
  • Developer Mailing List:
  • Slack Channel:
  • Public Meeting Schedule and Links:
  • Social Media:
  • Other Channel(s), If Any:

Resources

[TODO: Add links to other helpful information (roadmap, docs, website, etc.)]

License

This project is licensed under [TODO: Add name of license and link to your LICENSE file]

Conduct

We follow the CNCF Code of Conduct [TODO: Insert link to your CODE_OF_CONDUCT.md file].