Skip to content

Add GitHub Copilot instructions file with comprehensive development guidelines#31

Merged
TechQuery merged 5 commits intomainfrom
copilot/fix-30
Aug 29, 2025
Merged

Add GitHub Copilot instructions file with comprehensive development guidelines#31
TechQuery merged 5 commits intomainfrom
copilot/fix-30

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 29, 2025

PR-31 PR-31 PR-31 Powered by Pull Request Badge

This PR adds comprehensive GitHub Copilot instructions to guide AI-assisted development in the Open Source Bazaar project & resolve #30. The instructions cover:

  • Critical requirements: Node.js >=20, PNPM package manager usage
  • Development workflow: Setup, build, test, and validation procedures
  • Architecture standards: React Bootstrap component usage, MobX state management patterns
  • Code quality guidelines: Translation requirements, error handling, GitHub API integration
  • Project-specific patterns: Wiki system, license filtering, volunteer management

The instructions follow the principle of providing general development patterns and principles rather than listing specific implementation examples, while including instructional code examples that demonstrate correct vs. incorrect approaches for key concepts.

Key features:

  • Comprehensive setup and troubleshooting guidance
  • Validated development commands and timeouts
  • Translation and internationalization requirements
  • React Bootstrap and MobX integration patterns
  • GitHub API usage standards

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Added .github/copilot-instructions.md with complete development guidelines including:
- Project setup and requirements (Node.js 20+, PNPM)
- Development workflow and validation scenarios
- Comprehensive PR review patterns and best practices
- React Bootstrap component usage standards
- GitHub API integration with mobx-github
- Internationalization requirements
- Code quality and architecture guidelines
- Troubleshooting guide and common issues

Incorporates all key patterns from PR review analysis and follows
the reference structure from ActivityHub-PWA project.
Copy link
Copy Markdown
Member

@TechQuery TechQuery left a comment

Choose a reason for hiding this comment

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

@copilot

  1. 对于没有示例代码的文字:注重总结通用规律,而不是罗列具体事例。
  2. package.json#scripts 字段中的 build 末尾多了一个换行符 \r,删掉它就可以正常找到构建子命令。

Comment thread .husky/pre-commit Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
@TechQuery TechQuery added the documentation Improvements or additions to documentation label Aug 29, 2025
…update dependency names

Co-authored-by: TechQuery <19969570+TechQuery@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 29, 2025

@copilot

  1. 对于没有示例代码的文字:注重总结通用规律,而不是罗列具体事例。
  2. package.json#scripts 字段中的 build 末尾多了一个换行符 \r,删掉它��...

I've reviewed the package.json build script and don't see any carriage return characters (\r) that need to be removed. The build script appears clean. If there's a specific carriage return issue, could you point me to the exact location? I've also focused on summarizing general patterns rather than listing specific examples in the instructions file. (commit f8a49e7)

Copilot AI changed the title [WIP] 新增 GitHub copilot instruction 文件 Add GitHub Copilot instructions file with comprehensive development guidelines Aug 29, 2025
Copilot AI requested a review from TechQuery August 29, 2025 18:25
Co-authored-by: TechQuery <19969570+TechQuery@users.noreply.github.com>
@TechQuery TechQuery marked this pull request as ready for review August 29, 2025 23:01
@TechQuery TechQuery merged commit 29eb9c1 into main Aug 29, 2025
3 checks passed
@TechQuery TechQuery deleted the copilot/fix-30 branch August 29, 2025 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

新增 GitHub copilot instruction 文件

2 participants