Add i18n examples and revise the AI integration page for clarity. #774
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # CLAUDE.md | ||
|
|
||
| This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. | ||
|
|
||
| ## Repository Overview | ||
|
|
||
| This is the gitStream repository - a workflow automation tool for git repositories that allows users to create automated code review workflows using YAML and Jinja2 templates. gitStream processes Continuous Merge (CM) files (`.cm` extension) that define automations for pull/merge requests across GitHub, GitLab, and Bitbucket. | ||
|
|
||
| ## Development Commands | ||
|
|
||
| ### Documentation Server | ||
| The documentation is built using MkDocs Material theme. | ||
|
|
||
| ```bash | ||
| # Set up Python virtual environment (Python <= 3.10 required) | ||
| python -m venv .venv | ||
| . ./.venv/bin/activate | ||
|
|
||
| # Install dependencies | ||
| pip install -r requirements.txt | ||
|
|
||
| # Run documentation server locally | ||
| mkdocs serve # Runs at http://127.0.0.1:8000/ | ||
|
|
||
| # Build documentation | ||
| mkdocs build | ||
| ``` | ||
|
|
||
| ## Code Architecture | ||
|
|
||
| ### Project Structure | ||
| - **docs/** - Documentation source files (Markdown) | ||
| - `automations/` - Automation examples and library | ||
| - `downloads/` - Downloadable CM files and templates | ||
| - `integrations/` - Third-party integration documentation | ||
| - `screenshots/` - Documentation images | ||
| - **plugins/filters/** - JavaScript filter function plugins that extend gitStream capabilities | ||
| - Each plugin has its own directory with `index.js`, `README.md`, and optional test files | ||
| - Plugins enable custom data processing and external API integrations | ||
| - **site/** - Generated documentation site (do not edit directly) | ||
| - **automations/** - Example automation configurations | ||
| - **tutorials/** - Tutorial projects demonstrating gitStream usage | ||
|
|
||
| ### Core Concepts | ||
|
|
||
| 1. **CM Files (.cm)**: YAML + Jinja2 configuration files that define automation rules | ||
| - Located in `.cm/` directory at repository root | ||
| - Can also be defined at organization level in a special `cm` repository | ||
| - Each file must contain `manifest:` and `automations:` sections | ||
|
|
||
| 2. **Automation Components**: | ||
| - **Context Variables**: Pre-defined objects like `files`, `branch`, `repo` providing PR metadata | ||
| - **Filter Functions**: Functions applied to variables using pipe operator `|` | ||
| - **Automation Actions**: Actions like `add-comment`, `set-required-approvals`, `add-label` | ||
| - **Custom Expressions**: Reusable Jinja2 expressions defined in CM files | ||
|
|
||
| 3. **Plugin System**: JavaScript plugins in `plugins/filters/` that create new filter functions | ||
| - Each plugin exports a filter function that can be used in CM files | ||
| - Plugins can connect to external APIs or perform complex data processing | ||
|
|
||
| ### Key Files | ||
| - `mkdocs.yml` - Documentation site configuration | ||
| - `requirements.txt` - Python dependencies for documentation | ||
| - `.cm/*.cm` - Repository-level automation rules | ||
| - `docs/downloads/gitstream.cm` - Default automation template | ||
|
|
||
| ## Important Notes | ||
|
|
||
| - When editing CM files, preserve YAML indentation as it's significant | ||
| - Organization-level rules can be overridden by repository-level rules with the same identifier | ||
| - The identifier is composed of filename + automation name (e.g., `gitstream/safe_changes`) | ||
| - gitStream triggers on PR creation and updates by default, with configurable explicit triggers | ||
| - Draft PRs are ignored by default (configurable via explicit triggers on GitHub) |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,17 +7,17 @@ category: [quality, genai, copilot, tests, efficiency] | |
|
|
||
| !!! tip "User Commands" | ||
|
|
||
| LinearB's AI is available also with `/gs` user commands, read more about them [here](/user-commands). | ||
|
|
||
| <!-- --8<-- [start:examples]--> | ||
|
|
||
| ## Automation Examples | ||
|
|
||
| ### Code Review using LinearB's AI | ||
|
|
||
| --8<-- "docs/automations/integrations/LinearBAI/code-review/README.md:example" | ||
|
|
||
| ### PR Description Using LinearB's AI | ||
|
|
||
| --8<-- "docs/automations/integrations/LinearBAI/describe-pr/README.md:example" | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧾 Readability - Misleading Terminology: Change "Use Korean language for all comments" to "Use Korean language for all descriptions" to accurately reflect that this generates PR descriptions.