huafangyun / template

Template repository for nventive projects

Open Source Project Template

This repository contains a template to seed a repository for an Open Source project.

How to use this template

1. Check out this repository
2. Delete the .git folder
3. Git init this repository and start working on your project!
4. Prior to submitting your request for publication, make sure to review the Open Source guidelines for publications.

Features (to keep as-is, configure or remove)

• Mergify is configured. You can edit or remove .mergify.yml.
• dependabot is configured. This bot will open pull requests automatically to update nuget dependencies. This one could be annoying, feel free to remove the .dependabot folder.

The following is the template for the final README.md file:

---

Project Title

{Project tag line}

{Small description of the purpose of the project}

Getting Started

{Instructions to quickly get started using the project: pre-requisites, packages to install, sample code, etc.}

Features

{More details/listing of features of the project}

Breaking Changes

Please consult BREAKING_CHANGES.md for more information about version history and compatibility.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on the process for contributing to this project.

Be mindful of our Code of Conduct.