bytedance-flowgram/CONTRIBUTING.md

Contributing to flowgram.ai

Quick Start

Prerequisites

• Node.js 18+ (LTS/Hydrogen recommended)
• pnpm 10.6.5
• Rush 5.150.0

Installation

1. Install Node.js 18+

   nvm install lts/hydrogen
   nvm alias default lts/hydrogen # set default node version
   nvm use lts/hydrogen
   

2. Clone the repository

   git clone git@github.com:bytedance/flowgram.ai.git
   

3. Install required global dependencies

   npm i -g pnpm@10.6.5 @microsoft/rush@5.150.0
   

4. Install project dependencies

   rush install
   

5. Build the project

   rush build
   

6. Run docs or demo

   rush dev:docs # docs
   rush dev:demo-fixed-layout
   rush dev:demo-free-layout
   

After that, you can start to develop projects inside this repository.

Submitting Changes

1. Create a new branch from main using the format:

   • feat/description for features
   • fix/description for bug fixes
   • docs/description for documentation
   • chore/description for maintenance

2. Write code and tests

   • Follow our coding standards
   • Add/update tests for changes
   • Update documentation if needed

3. Ensure quality

   • Run cd path/to/packageName && npm test for all tests
   • Run rush lint for code style
   • Run rush build to verify build

4. Create Pull Request

   • Use the PR template
   • Link related issues
   • Provide clear description of changes

5. Review Process

   • Maintainers will review your PR
   • Address review feedback if any
   • Changes must pass CI checks

6. Commit Message Format

   type(scope): subject
   body
   

   Types: feat, fix, docs, style, refactor, test, chore

Reporting Bugs

Report bugs via GitHub Issues. Please include:

• Issue description
• Steps to reproduce
• Expected behavior
• Actual behavior
• Code examples (if applicable)

Documentation

• Update API documentation for interface changes
• Update README.md if usage is affected

License

This project is under the MIT License. By submitting code, you agree to these terms.