A brief description of the project goes here.
Any useful links to external documentation or anything else that may be relevant. Include a link to the documentation for any and all code standards for whatever langauges this project uses.
Include a link to the projects Confluence team page here.
Include any information needed on how to get the project up and running for development, how to create a user (or any other needed configuration) in different enviroments, what tools most team members use (IDE, etc.), how to build the project, and anything else that could be useful in getting started.
Information on the tech stack of the project and any integrations
LightHouse Studios uses Trunk Based Development as a git Strategy. Feature Flags are a large part of that strategy. Feature Flags for this Project:
FeatureFlag1: Description FeatureFlag2: Description FeatureFlag3: Description
Information on Unit Test, how to run them, and any other testing sollutions (UI Test, etc). Find a way to link in automatically updated code coverage here if possible? Maybe have a github action on merge into master to check new code coverage stats and update README
Information on any pipelines GitHub workflows in the project and how/why to run them.
What workflows to run from what branch and with what setup in order to build for production and deploy the app to production, along with anything else that may be relevant to building for production and releasing.
Any terms that are used within the project that may be specific to the project or the business logic that would be useful to know.