Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.77 KB

README-template.md

File metadata and controls

76 lines (50 loc) · 2.77 KB
Raw

README

Please start by renaming this to README.md and deleting everything up to and including the "template begins here" comment in this markdown file.

Welcome to [TODO:Projectname]!

[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: Depending on the length of the README, including a table of contents can be helpful to the reader (optional)]

Getting Started

Contributing

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

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 (blogs, tutorials, videos, roadmap, docs, website, etc.)]

License

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

Code of Conduct

We follow the Contributor Covenant Code of Conduct.

Examples of behavior that contributes to a positive environment for our community include:

  • Demonstrating empathy and kindness toward other people
  • Being respectful of differing opinions, viewpoints, and experiences
  • Giving and gracefully accepting constructive feedback

Examples of unacceptable behavior include:

  • The use of sexualized language or imagery, and sexual attention or advances of any kind
  • Trolling, insulting or derogatory comments, and personal or political attacks
  • Public or private harassment

Please take a moment to read and familiarise yourself with the complete code of conduct as this will govern your interactions and contributions to this project.