Skip to content

Update changelog rule #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 31, 2025
Merged

Update changelog rule #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1774b7d
Update changelog rule
nao1215 Aug 31, 2025
324fd65
Merge branch 'main' into nchika/changelog-rule
nao1215 Aug 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .cursorrules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ filesql reads the contents of specified input files and returns [sql.DB](https:/
- doc/ko/README.md
- doc/ru/README.md
- doc/zh-cn/README.md
- CHANGELOG.md maintenance: When updating CHANGELOG.md, always include references to the relevant PR numbers and commit hashes with clickable GitHub links. This helps developers trace which specific changes were made in which PR/commit and allows them to browse the actual code changes. Format examples:
- **Feature description ([abc1234](https://github.com/nao1215/filesql/commit/abc1234))**: Detailed explanation of the change
- **Feature description (PR #123, [abc1234](https://github.com/nao1215/filesql/commit/abc1234))**: When both PR and commit are relevant
- Use `git log --oneline` and GitHub PR numbers to identify the specific changes
- Always format commit hashes as clickable links: `[hash](https://github.com/nao1215/filesql/commit/hash)`
- This improves traceability and allows developers to browse code changes directly in their browser
- Users want to see the actual implementation, so always provide GitHub links for commits

## Testing
- [Readable Test Code](https://logmi.jp/main/technology/327449): Avoid excessive optimization (DRY) and aim for a state where it's easy to understand what tests exist.
Expand Down
10 changes: 9 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ filesql reads the contents of specified input files and returns [sql.DB](https:/
- doc/ko/README.md
- doc/ru/README.md
- doc/zh-cn/README.md
- CHANGELOG.md maintenance: When updating CHANGELOG.md, always include references to the relevant PR numbers and commit hashes with clickable GitHub links. This helps developers trace which specific changes were made in which PR/commit and allows them to browse the actual code changes. Format examples:
- **Feature description ([abc1234](https://github.com/nao1215/filesql/commit/abc1234))**: Detailed explanation of the change
- **Feature description (PR #123, [abc1234](https://github.com/nao1215/filesql/commit/abc1234))**: When both PR and commit are relevant
- Use `git log --oneline` and GitHub PR numbers to identify the specific changes
- Always format commit hashes as clickable links: `[hash](https://github.com/nao1215/filesql/commit/hash)`
- This improves traceability and allows developers to browse code changes directly in their browser
- Users want to see the actual implementation, so always provide GitHub links for commits

## Testing
- [Readable Test Code](https://logmi.jp/main/technology/327449): Avoid excessive optimization (DRY) and aim for a state where it's easy to understand what tests exist.
Expand All @@ -58,4 +65,5 @@ When generating code suggestions, GitHub Copilot should:
2. Ensure all generated code follows the Effective Go guidelines
3. Include proper godoc comments for all public APIs
4. Suggest parallel test execution with `t.Parallel()` where appropriate
5. Use `filepath.Join()` for path operations to ensure cross-platform compatibility
5. Use `filepath.Join()` for path operations to ensure cross-platform compatibility
6. When updating CHANGELOG.md, include PR numbers and commit hashes with clickable GitHub links for traceability and code browsing
Loading
Loading