Commit 693ef59
docs: clean up redundant Copilot instructions (#540)
The `.github/copilot-instructions.md` file contained setup instructions
that duplicated the automated setup already provided by
`copilot-setup-steps.yml`. This created confusion and unnecessary
maintenance overhead.
## Changes Made
**Removed redundant setup sections:**
- Eliminated manual environment setup instructions (Python, uv,
pre-commit, pyright installation)
- Removed the entire "Copilot Agent Environment Setup" section that
duplicated automated setup
- Simplified the "Bootstrap, Build, and Test" section to focus on usage
rather than setup
**Updated documentation to reflect automated setup:**
- Modified environment setup instructions to simply reference activating
the pre-configured virtual environment
- Updated troubleshooting section to reflect that tools are
pre-installed
- Revised development notes to mention the pre-configured environment
**Preserved essential information:**
- Kept all usage instructions for running tests, linting, type checking,
and building documentation
- Maintained CLI usage examples and validation steps
- Preserved timing information and troubleshooting guidance
## Impact
The instructions now accurately reflect that the Copilot environment
automatically sets up all necessary tools, eliminating redundancy while
maintaining all essential information for developers. This reduces
confusion and ensures the documentation stays in sync with the automated
setup process.
Fixes #539.
> [!WARNING]
>
> <details>
> <summary>Firewall rules blocked me from connecting to one or more
addresses (expand for details)</summary>
>
> #### I tried to connect to the following addresses, but was blocked by
firewall rules:
>
> - `docs.deepmodeling.com`
> - Triggering command:
`/home/REDACTED/work/dpdispatcher/dpdispatcher/.venv/bin/python3
/home/REDACTED/work/dpdispatcher/dpdispatcher/.venv/bin/sphinx-build -M
html . _build` (dns block)
> - `docs.python.org`
> - Triggering command:
`/home/REDACTED/work/dpdispatcher/dpdispatcher/.venv/bin/python3
/home/REDACTED/work/dpdispatcher/dpdispatcher/.venv/bin/sphinx-build -M
html . _build` (dns block)
>
> If you need me to access, download, or install something from one of
these locations, you can either:
>
> - Configure [Actions setup
steps](https://gh.io/copilot/actions-setup-steps) to set up my
environment, which run before the firewall is enabled
> - Add the appropriate URLs or hosts to the custom allowlist in this
repository's [Copilot coding agent
settings](https://github.com/deepmodeling/dpdispatcher/settings/copilot/coding_agent)
(admins only)
>
> </details>
<!-- START COPILOT CODING AGENT TIPS -->
---
💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.
---------
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: njzjz <[email protected]>1 parent 41872d2 commit 693ef59
1 file changed
+5
-27
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | 14 | | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | 15 | | |
20 | 16 | | |
21 | 17 | | |
| |||
55 | 51 | | |
56 | 52 | | |
57 | 53 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | 54 | | |
77 | 55 | | |
78 | 56 | | |
| |||
177 | 155 | | |
178 | 156 | | |
179 | 157 | | |
180 | | - | |
| 158 | + | |
181 | 159 | | |
182 | 160 | | |
183 | 161 | | |
184 | | - | |
| 162 | + | |
185 | 163 | | |
186 | 164 | | |
187 | 165 | | |
188 | 166 | | |
189 | 167 | | |
190 | | - | |
191 | | - | |
| 168 | + | |
| 169 | + | |
192 | 170 | | |
193 | 171 | | |
194 | 172 | | |
0 commit comments