Skip to content

Repository template / starter-kit for best-practices in repository project setup, including open source essentials like contributing guides, licenses, code of conducts, issue / PR templates, etc.

License

Notifications You must be signed in to change notification settings

NASA-AMMOS/slim-starterkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


[INSERT YOUR LOGO IMAGE HERE (IF APPLICABLE)]

[INSERT YOUR REPO / PROJ NAME HERE]

[INSERT A SINGLE SENTENCE DESCRIBING THE PURPOSE OF YOUR REPO / PROJ]

[INSERT YOUR BADGES HERE (SEE: https://shields.io)] SLIM

[INSERT SCREENSHOT OF YOUR SOFTWARE, IF APPLICABLE]

[INSERT MORE DETAILED DESCRIPTION OF YOUR REPOSITORY HERE]

[INSERT LIST OF IMPORTANT PROJECT / REPO LINKS HERE]

Features

  • [INSERT LIST OF FEATURES IMPORTANT TO YOUR USERS HERE]

Contents

Quick Start

This guide provides a quick way to get started with our project. Please see our [docs]([INSERT LINK TO DOCS SITE / WIKI HERE]) for a more comprehensive overview.

Requirements

  • [INSERT LIST OF REQUIREMENTS HERE]

Setup Instructions

  1. [INSERT STEP-BY-STEP SETUP INSTRUCTIONS HERE, WITH OPTIONAL SCREENSHOTS]

Run Instructions

  1. [INSERT STEP-BY-STEP RUN INSTRUCTIONS HERE, WITH OPTIONAL SCREENSHOTS]

Usage Examples

  • [INSERT LIST OF COMMON USAGE EXAMPLES HERE, WITH OPTIONAL SCREENSHOTS]

Build Instructions (if applicable)

  1. [INSERT STEP-BY-STEP BUILD INSTRUCTIONS HERE, WITH OPTIONAL SCREENSHOTS]

Test Instructions (if applicable)

  1. [INSERT STEP-BY-STEP TEST INSTRUCTIONS HERE, WITH OPTIONAL SCREENSHOTS]

Changelog

See our CHANGELOG.md for a history of our changes.

See our [releases page]([INSERT LINK TO YOUR RELEASES PAGE]) for our key versioned releases.

Frequently Asked Questions (FAQ)

[INSERT LINK TO FAQ PAGE OR PROVIDE FAQ INLINE HERE]

Contributing

[INSERT LINK TO CONTRIBUTING GUIDE OR FILL INLINE HERE]

[INSERT LINK TO YOUR CODE_OF_CONDUCT.md OR SHARE TEXT HERE]

[INSERT LINK TO YOUR GOVERNANCE.md OR SHARE TEXT HERE]

License

See our: LICENSE

Support

[INSERT CONTACT INFORMATION OR PROFILE LINKS TO MAINTAINERS AMONG COMMITTER LIST]

About

Repository template / starter-kit for best-practices in repository project setup, including open source essentials like contributing guides, licenses, code of conducts, issue / PR templates, etc.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published