Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.13 KB

README_TEMPLATE.md

File metadata and controls

49 lines (30 loc) · 1.13 KB

YOUR_REPO_NAME_HERE

🌲 Purpose

Give a brief description of what the code in the repository does or is for

🌱 Getting started

Instructions for how to consume (library) or use (app) this package.

🔨 Development

Include all instructions a (new) developer needs to perform to get going developing for this project. Add info about specific tools if needed.

As an example

Run:

# Install dependencies
npm install

# Start serving the app
npm run dev

NOTE: Add things to take special not of if needed

🆒 Technology stack

  • typescript
  • swift
  • node (v16)

🔀 Branch strategy and protection

Indicate the name of the main branch and how branch protection is setup. Mention if special practices like git flow are in effect. Below is the most common text you will see here:

The main branch has protection enabled against direct pushes. All changes need to be done through a reviewed pull request.

🆙 Deploying

Describe how any package is published or how the app is deployed. This should almost always be done using CI (GitHub actions, Bitrise, etc.)