https://github.com/nasa-ammos/slim-starterkit

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.
https://github.com/nasa-ammos/slim-starterkit

Last synced: 5 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/nasa-ammos/slim-starterkit
• Owner: NASA-AMMOS
• License: apache-2.0
• Created: 2022-12-08T23:46:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T23:57:03.000Z (about 2 years ago)
• Last Synced: 2025-06-03T23:48:33.670Z (about 1 year ago)
• Size: 55.7 KB
• Stars: 5
• Watchers: 7
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Governance: GOVERNANCE.md

Awesome Lists containing this project

README

          





[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](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.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](#quick-start)

* [Changelog](#changelog)

* [FAQ](#frequently-asked-questions-faq)

* [Contributing Guide](#contributing)

* [License](#license)

* [Support](#support)

## 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](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](LICENSE)

## Support

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