Skip to content

Commit 5a1bc5b

Browse files
mekarpelesMek
authored andcommitted
Add comprehensive GitHub Copilot agent instructions
1 parent b150b32 commit 5a1bc5b

File tree

3 files changed

+701
-0
lines changed

3 files changed

+701
-0
lines changed

.github/agents/README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# GitHub Copilot Agent Instructions
2+
3+
This directory contains instructions and guidelines for GitHub Copilot agents working on Open Library tasks.
4+
5+
## Files
6+
7+
### [open-library-instructions.md](open-library-instructions.md)
8+
Comprehensive development instructions covering:
9+
- Repository structure and architecture
10+
- Initial setup and Docker configuration
11+
- Building assets (JS, CSS, Vue, Lit components)
12+
- Running tests (Python, JavaScript, i18n)
13+
- Linting and code quality checks
14+
- Internationalization (i18n) workflows
15+
- Development workflow best practices
16+
- Common troubleshooting scenarios
17+
- Full reference documentation
18+
19+
**Use this file** for detailed, step-by-step guidance when working on Open Library tasks.
20+
21+
### [quick-reference.md](quick-reference.md)
22+
Condensed quick reference guide with:
23+
- Essential commands at a glance
24+
- Common workflows
25+
- Typical issue solutions
26+
- Key file structure
27+
- Quick reminders
28+
29+
**Use this file** for quick command lookups during development.
30+
31+
## Purpose
32+
33+
These instructions are designed to:
34+
1. **Reduce repeated work** - Agents no longer need to discover basic setup/build/test procedures
35+
2. **Standardize processes** - Ensure consistent development practices across all agent tasks
36+
3. **Speed up development** - Provide instant access to verified commands and workflows
37+
4. **Improve quality** - Include linting, testing, and verification steps in all workflows
38+
39+
## Usage for Agents
40+
41+
When starting work on an Open Library issue:
42+
43+
1. Read the issue description carefully
44+
2. Consult [open-library-instructions.md](open-library-instructions.md) for setup if needed
45+
3. Follow the "Typical Task Workflow for Agents" section
46+
4. Use [quick-reference.md](quick-reference.md) for quick command lookups
47+
5. Always run tests and linters before submitting changes
48+
49+
## Usage for Contributors
50+
51+
These instructions are also valuable for human contributors! They provide:
52+
- Clear setup instructions
53+
- Common command reference
54+
- Troubleshooting guidance
55+
- Best practices
56+
57+
## Maintenance
58+
59+
These instructions should be updated when:
60+
- Docker configuration changes
61+
- New build processes are added
62+
- Testing procedures are modified
63+
- New linting tools are introduced
64+
- Common issues are discovered
65+
66+
## Additional Resources
67+
68+
- [Docker README](../../docker/README.md) - Detailed Docker setup and troubleshooting
69+
- [CONTRIBUTING.md](../../CONTRIBUTING.md) - General contribution guidelines
70+
- [Frontend Guide](https://github.com/internetarchive/openlibrary/wiki/Frontend-Guide) - Frontend development details
71+
- [Testing Guide](https://github.com/internetarchive/openlibrary/wiki/Testing) - Comprehensive testing documentation
72+
- [Wiki](https://github.com/internetarchive/openlibrary/wiki) - Full project documentation
73+
74+
## Feedback
75+
76+
If you find issues with these instructions or have suggestions for improvements:
77+
1. Open an issue on GitHub
78+
2. Submit a PR with updates
79+
3. Discuss in community calls
80+
81+
These instructions are living documents that should evolve with the project!

0 commit comments

Comments
 (0)