55 строки
1.4 KiB
Markdown
55 строки
1.4 KiB
Markdown
|
# 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](https://nventive.visualstudio.com/Internal/_wiki/wikis/Internal_wiki?wikiVersion=GBwikiMaster&pagePath=%2FOpen%20Source%2FPublishing&pageId=7120).
|
||
|
|
|
||
|
|
The following is the template for the final README.md file:
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
# Project Title
|
||
|
|
|
||
|
|
{Project tag line}
|
||
|
|
|
||
|
|
{Small description of the purpose of the project}
|
||
|
|
|
||
|
|
[](LICENSE)
|
||
|
|
|
||
|
|
## 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}
|
||
|
|
|
||
|
|
## Changelog
|
||
|
|
|
||
|
|
Please consult the [CHANGELOG](CHANGELOG.md) for more information about version
|
||
|
|
history.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the Apache 2.0 license - see the
|
||
|
|
[LICENSE](LICENSE) file for details.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for
|
||
|
|
contributing to this project.
|
||
|
|
|
||
|
|
Be mindful of our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||
|
|
|
||
|
|
## Acknowledgments
|
||
|
|
|
||
|
|
{List similar projects, inspirations, etc. related to this project.}
|