Code Monkey home page Code Monkey logo

project-template's Introduction

README

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)]

Getting Started

Contributing

Our project welcomes contributions from any member of our community. To get started contributing, please see our Contributor Guide.

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].

project-template's People

Contributors

carolynvs avatar jberkus avatar idvoretskyi avatar geekygirldawn avatar caniszczyk avatar ldatb avatar xmulligan avatar leogr avatar ldeataid avatar

Forkers

linecomparison

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.