<aside> 📜 TABLE OF CONTENTS

• Introduction
• Getting Started
• Management Methodology
• Git Methodology
• API Documentation
• Database Schema
• Tech stack
• Dev plan
• meetings
• Third party code
• Stakeholder interactions
• Testing </aside>

Methodology 📐

this project uses the GitHub flow methodology, which is a lightweight, branch-based workflow perfect for agile development.

Main Steps

• Create a branch
• Make changes
• Create a pull request
• Address review comments
• Merge your pull request
• Delete the branch

Supporting links

• see the links below to read more about the to read more about the GitHub flow
• https://docs.github.com/en/get-started/using-github/github-flow
• https://www.w3schools.com/git/git_github_flow.asp?remote=github

Versioning

for this project semantic versioning is used for all for releases

see the link below to read more about semantic versioning

https://semver.org/