feat: add comprehensive GitHub Copilot instructions with development standards - #311
Conversation
|
@njzjz 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
…tion Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
|
@copilot Please add the following requirements to the instruction:
This PR should follow the same requirements. You committed a lot of temp files. |
- Remove 4798 test artifact files that were incorrectly committed - Add semantic commit message requirements - Update installation commands to prefer uv over pip - Improve package manager guidance in instructions Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
I've addressed all your feedback in commit 1d48ce9: ✅ Semantic commit messages: Added comprehensive requirements with format and examples The instructions now include clear guidance on conventional commit format and prefer |
|
@copilot There are still some committed files generated by the tests. |
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Removed all remaining test artifacts that were accidentally committed and enhanced .gitignore patterns to prevent this in the future. Cleaned up: tests/incar, tests/potcar, tests/init_data/ directory, and improved .gitignore with additional patterns. (0c8582b) |
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #311 +/- ##
=======================================
Coverage 84.23% 84.23%
=======================================
Files 104 104
Lines 6129 6129
=======================================
Hits 5163 5163
Misses 966 966 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed guidance on working effectively with the DPGEN2 codebase, including modern development standards and tooling preferences.Key Features
Development Standards:
feat:,fix:,docs:, etc.)uvoverpipfor faster Python dependency managementInstallation & Setup:
Testing Framework:
Code Quality:
Comprehensive Coverage
The instructions provide:
dpgen2 submit,status,watch, etc.)All commands have been validated to work correctly with the current repository state. The instructions enable coding agents to work efficiently with DPGEN2's concurrent learning workflow system while following modern Python development practices.
Additionally, enhanced
.gitignorepatterns prevent test artifacts from being accidentally committed during development work.Fixes #310.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.