Skip to content

docs: CONTRIBUTING, AGENTS, CI, issue templates, and unit tests - #6

Merged
MisterBrookT merged 4 commits into
mainfrom
claude/go-execution-ZgMFl
Jun 4, 2026
Merged

MisterBrookT merged 4 commits into
mainfrom
claude/go-execution-ZgMFl

Conversation

@MisterBrookT

Copy link
Copy Markdown
Owner

Summary\n\n一次性补齐开源项目该有的基础设施:\n\n- CONTRIBUTING.md — dev setup、代码风格、commit 规范、PR checklist、项目结构说明\n- AGENTS.md — 给 AI coding agent(Claude Code / Copilot / Cursor)看的架构导读:数据模型、文件地图、如何加新 provider、常用命令、常见错误\n- CHANGELOG.md — 初始 v0.1.0 条目(commitizen 格式)\n- .env.example — 三个 API key 的模板,含链接\n- .github/workflows/ci.yml — Ruff lint + format check + pytest,跑 Python 3.10 / 3.11 / 3.12\n- .github/ISSUE_TEMPLATE/ — bug report + feature request(YAML 格式)\n- tests/ — 20 个单元测试,覆盖 VISItem 加载/保存/round-trip/业务逻辑,不需要任何 API key\n\n## Test plan\n\n- [ ] uv run pytest tests/ -v 本地全部通过\n- [ ] CI 三个 Python 版本全绿\n- [ ] AGENTS.md 内容准确反映当前代码结构"


Generated by Claude Code

…nit tests

- CONTRIBUTING.md: dev setup, code style, PR workflow
- AGENTS.md: architecture guide for AI coding agents
- CHANGELOG.md: initial v0.1.0 entry
- .env.example: API key template
- .github/workflows/ci.yml: ruff lint + pytest on Python 3.10/3.11/3.12
- .github/ISSUE_TEMPLATE/: bug report + feature request YAML templates
- tests/: VISItem unit tests (no API keys required)

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds project configuration, documentation, and testing infrastructure for the IGenBench tool, including environment templates, GitHub issue templates, an AI agent guide, contributing guidelines, and unit tests for the VISItem data model. The review feedback points out unused imports (json, os, and pytest) in the newly added test file that should be removed to clean up the code.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread tests/test_vis_item.py Outdated
Comment on lines +3 to +7
import json
import os
from pathlib import Path

import pytest

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The imports json, os, and pytest are not used anywhere in this test file. Removing unused imports helps keep the codebase clean and adheres to PEP 8 style guidelines.

Suggested change
import json
import os
from pathlib import Path
import pytest
from pathlib import Path
References
  1. Unused imports should be removed to keep the namespace clean and adhere to PEP 8. (link)

@MisterBrookT
MisterBrookT marked this pull request as ready for review June 4, 2026 12:30
@MisterBrookT
MisterBrookT merged commit b2af6e7 into main Jun 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants