Skip to content

Latest commit

 

History

History
94 lines (60 loc) · 3.83 KB

software-readme-template.md

File metadata and controls

94 lines (60 loc) · 3.83 KB

Name of software project

Contents

File/folder Description
src source code.
CHANGELOG.md List of changes to the project.
README.md This README file.
LICENSE.txt The license for the project.

Prerequisites

  • Windows/Linux version
  • Visual Studio/VSCode version
  • Azure Sphere OS and/or SDK version xxx
  • Any specific Azure Sphere hardware?
  • Other hardware?
  • Azure subscription, Azure IoT setup, etc.?

Setup

Running the code

Key concepts

Discuss the aspects of the project that might be particularly useful to someone looking at it:

  • Significant design decisions
  • Gotchas and tricky bits
  • Opportunities for customization

Next steps

Project expectations

Describe the state of the code. For example:

  • The code is not secure (for example, connection strings are included in the code).
  • The code is grossly inefficient (for example, loops that run unnecessarily because it uses the wrong breakout points).
  • The code does not run (for example, there are build errors).
  • The code may cause a problem if used in a production scenario.
  • The code has not been run through a complete security analysis (for example, there are static analysis failures).

Expected support for the code

How often will you check and reply to issues or maintain and update the code? For example:

  • Will reply to issues once per quarter, once a year, etc.
  • No support whatsoever, code is as is

Telemetry collection

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

License

For details on license, see LICENSE.txt in this directory.