ArtifactType	Documentation	Language	Platform	Stackoverflow	Tags	ms.reviewedAt	ms.reviewedBy
nupkg, executable, azure-web-app, azure-cloud-service, etc. More requirements for artifact type standardization may come later.	URL	typescript, csharp, java, js, python, golang, powershell, markdown, etc. More requirements for language names standardization may come later.	windows, node, linux, ubuntu16, azure-function, etc. More requirements for platform standardization may come later.	URL	comma,separated,list,of,tags	Date of last review in mm/dd/yyyy format	alias of person that last reviewed this file

Project Title. MUST BE topmost header

One Paragraph of project description goes here. Including links to other user docs or a project website is good here as well. This paragraph will be used as a blurb on CodeHub. Please make the first paragraph short and to the point.

You can expand on project description in subsequent paragraphs. It is a good practice to explain how this project is used and what other projects depend on it.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development environment running

1. Describe what needs to be done first

   Give an example of performing step 1

2. And then repeat for each step

   Another example, this time for step 2

Running the tests

Explain how to run the tests for this project that are relevant to users. You can also link to the testing portion of CONTRIBUTING.md for tests relevant to contributors.

End-to-end tests

Explain what these tests test and why

Give an example

Unit tests

Explain what these test and why

Give examples

Deployment

Add additional notes about how to deploy this on a live system

Built With

Documenting some of the main tools used to build this project, manage dependencies, etc will help users get more information if they are trying to understand or having difficulties getting the project up and running.

• Link to some dependency manager
• Link to some framework or build tool
• Link to some compiler, linting tool, bundler, etc

Contributing

Please read our CONTRIBUTING.md which outlines all of our policies, procedures, and requirements for contributing to this project.

Versioning and changelog

We use SemVer for versioning. For the versions available, see the tags on this repository.

It is a good practice to keep CHANGELOG.md file in repository that can be updated as part of a pull request.

Authors

List main authors of this project with a couple of words about their contribution.

Also insert a link to the owners.txt file if it exists as well as any other dashboard or other resources that lists all contributors to the project.

License

This project is licensed under the < INSERT LICENSE NAME > - see the LICENSE file for details

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc