A collection of github repo templates (readme, pull requests, issues, etc.)

readme-template.md

Project Title

Simple overview of use/purpose.

Key Features

• Describe key features

Getting Started

Dependencies

• Describe any prerequisites, libraries, OS version, etc., needed before installing program.
• ex. Windows 10

Installing

• How/where to download your program
• Any modifications needed to be made to files/folders

Testing

How to run the tests:

code block for tests

Usage

• How to run the program
• Step-by-step bullets

code blocks for commands

Deployments

Info about deployments, if available

Acknowledgments

• Inspiration, code snippets, etc.

issue-template.md

Expected Behavior

Please describe the behavior you are expecting

Current Behavior

What is the current behavior?

Failure Information (for bugs)

Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.

Steps to Reproduce

Please provide detailed steps for reproducing the issue.

1. step 1
2. step 2
3. etc...

Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

• Firmware Version:
• Operating System:
• SDK version:
• Toolchain version:

Failure Logs

Please include any relevant log snippets or files here.

pull-request-template.md

Jira Ticket

Ticket

Description

Summary of the change. Please also include relevant motivation and context.

How This Was Tested

Description of how the changes were tested.

Related PRs

List any dependencies that are required for this change, if any.