Template Repository

This repository serves as a personal repository template. Pre- population of common technologies added.

Table of Contents

• Description
• Getting Started
  • Prerequisites and Main Dependencies
  • Installation
• Usage
• Testing
• Deployment
  • Server
  • Brances
• Additional Documentation
• Changelog
• Roadmap
• Authors
• Additional readme addons
  • Badges
    • Dynamic License
    • Standard README
    • Repository NOT maintained
    • Repository maintained
    • Custom Badges
  • Alternative Header
• Authors
• Contributors and Acknowledgements
• Contributing
• License

Description

One to two paragraphs about the project: What is this project about? What does the project do? Why is it useful? What problem does it solve? Who is it for?

Getting Started

Prerequisites and Main Dependencies

Installation

How do you install the project and what do you need for it? Mention all dependencies that need to be installed first. Ideally, you also provide version numbers. (I’m looking at you, Node.js…)

Example:

git clone https://github.com/username/repository

Usage

Instructions for how to configure, run, and use the project. For example, you can include the commands needed to install and start the development environment or any other useful and important commands. Screenshots can be included as well.

For more examples and usage, please refer to the Documentation.

Testing

Any unit or integration tests people can run to assure that everything’s working as expected? Any frameworks or commands that are needed here? And are there any tests in your deployment pipeline that ensure that no errors make it into the live site?

Also include the commands needed to run any tests:

npm run test

Deployment

Instructions for how to deploy the project to a production environment, including any server requirements and commands used. And, in case you are using a CI/CD pipeline, for example, how do any automated processes work? What are the most important branches? Do they trigger any pipelines?

Server

• Live: https://zothsu.github.io/template/
• Staging:
• Development:

Branches

• Main:
• Feature:
• Bugfix:
• etc...

npm run build

Additional Documentation

• Project folder on server: …
• Confluence link: …
• Slack project channel: …
• etc...

Changelog

We use Semantic Versioning for versioning.

• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
  • FIX: Crash when calling pleasedonotcrash() (Thanks @AmazingContributorName!)
• 0.0.1
  • Work in progress

Roadmap

• Add intital README draft
• A new feature on the roadmap
• Add another feature
• And another one
• Multi-language Support
  • English
  • Chinese
  • Spanish

additionalreadmeaddons

Note: These add-on's are here for other readme documentaion that might have more design focused needs.

Requirements for a Standard README

• Be called README.md (with capitalization).
• If the project supports i18n, the file must be named accordingly: README.de.md, where de is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages. If there is only one README and the language is not English, then a different language in the text is permissible without needing to specify the BCP tag: e.g., README.md can be in German if there is no README.md in another language. Where there are multiple languages, README.md is reserved for English.
• Be a valid Markdown file.
• Sections must appear in order given below. Optional sections may be omitted.
• Sections must have the titles listed below, unless otherwise specified. If the README is in another language, the titles must be translated into that language.
• Must not contain broken links.
• If there are code examples, they should be linted in the same way as the code is linted in the rest of the project.

Standard README specifications

View all Standard README specifications provided by RichardLitt.

Table of Contents

• Sections

  • Title
  • Banner
  • Badges
  • Short Description
  • Long Description
  • Table of Contents
  • Security
  • Background
  • Install
  • Usage
  • Extra Sections
  • API
  • Maintainers
  • Thanks
  • Contributing
  • License

• Definitions

  Badges

  A collection of some frequently used badges. Badges from shields.io

  dynamicLicense

  Generates license dynamically according to repository indicated in URL

  ![GitHub](https://img.shields.io/github/license/username/repository)

  standardREADME Version

  Readme stylization follows Richard Litt's standard readme

  [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-g.svg)](https://github.com/RichardLitt/standard-readme)

  Open-source README version

  Readme stylization follows David Larlet's open-source-readme

  [![open-source-readme](https://img.shields.io/badge/readme%20style-open_source-g.svg)](https://github.com/davidbgk/open-source-template)

  Repository Not maintained

  Repsitory is not maintained by it's owner

  [![Maintenance](https://img.shields.io/badge/Maintained%3F-No-red.svg)](https://shields.io/badges/static-badge)

  Repository Actively Maintained

  Repository is actively maintained by it's owner

  [![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-g.svg)](https://shields.io/badges/static-badge)

  Custom Badges

  Static badges allowing customizable text

  [![https://shields.io/badges/static-badge](https://img.shields.io/badge/any_text-you_like-159ee0)](https://img.shields.io/badge/any_text-you_like-159ee0)

Alternative Header

Authors

Contributors and Acknowledgments

• Thanks to those amazing people: A, B, C (with links to their profiles/websites)
• Hat tip to anyone whose code is used
• Inspiration
• etc

Matthias Ott - README Template - matthiasott

To kyechan99 for the absolutely spectacular capsule-render!

Richard Litt's Standard Readme

https://github.com/hackergrrl/art-of-readme

https://github.com/davidbgk/open-source-template/

Contributing

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Important: Does this project use any sprecific coding guidelines, styles, or does it have a code of conduct?

License

Distributed under the XYZ license. See LICENSE for more information.