Add initial README, MIT license, and contribution guidelines#2
Merged
ganeshwhere merged 2 commits intomainfrom Mar 4, 2026
Merged
Add initial README, MIT license, and contribution guidelines#2ganeshwhere merged 2 commits intomainfrom
ganeshwhere merged 2 commits intomainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces foundational documentation for the Team Flow monorepo, including contribution guidelines, licensing, and comprehensive project-level READMEs. These changes clarify project structure, setup, environment configuration, and development workflows for both new and existing contributors.
Documentation and Contribution Workflow
CONTRIBUTING.mddescribing prerequisites, setup steps, branching strategy, coding standards, testing policy, database migration rules, pull request requirements, and security practices for the monorepo.Project and App Documentation
README.mdoutlining Team Flow's tech stack, monorepo structure, environment setup, development scripts, API route overview, and troubleshooting tips.apps/api/README.mddocumenting backend responsibilities, environment variables, database setup, core scripts, API surface, and troubleshooting for the NestJS service.apps/web/README.mddocumenting frontend responsibilities, environment variables, OAuth setup, scripts, feature notes, and troubleshooting for the Next.js app.Legal and Licensing
LICENSEfile specifying the MIT license for all Team Flow contributions.