Add comprehensive GitHub Copilot instructions for development workflow #842
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Created
.github/copilot-instructions.md
with comprehensive instructions for GitHub Copilot to work effectively in this Redmine plugin codebase.Key Features
Imperative tone throughout: All commands use clear directives like "Run [command]", "Do not [action]", following the requested style.
Exhaustive validation: Every single command was tested and validated to work correctly:
Critical timing information: All commands include "NEVER CANCEL" warnings with specific timeout recommendations based on actual measured execution times plus 50% buffer.
Clear limitations: Explicitly explains this is a Redmine plugin that cannot run standalone, preventing common mistakes like attempting
rails server
orrake
commands without the full Redmine environment.Complete setup documentation: Includes the full 45+ minute CI setup process for those who need to test with a complete Redmine installation, including:
Practical examples: Includes actual command outputs, repository structure listing, and expected linting results to help agents understand what success looks like.
Development safety: Added
vendor/bundle
to.gitignore
to prevent committing development artifacts.The instructions enable GitHub Copilot to immediately start productive development work with proper linting and validation while clearly defining the boundaries of what's possible in this plugin environment.
Fixes #841.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.