Skip to content

Add comprehensive GitHub Copilot instructions for development workflow #842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Aug 11, 2025

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:

  • Bundle install (83 seconds)
  • Yarn install (27 seconds)
  • RuboCop linting (2 seconds, 328 files)
  • Slim-lint for views (3 seconds)
  • StyleLint for CSS (0.5 seconds)
  • Brakeman security scanning (3 seconds)

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 or rake 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:

  • System dependencies (build-essential, cmake, libgpg-error-dev, etc.)
  • Gitolite installation and SSH key setup
  • Required plugin dependencies (additionals, redmine_sidekiq)
  • Database configuration

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.

@Copilot Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for development workflow Aug 11, 2025
@Copilot Copilot AI requested a review from PowerKiKi August 11, 2025 12:00
Copilot finished work on behalf of PowerKiKi August 11, 2025 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨Set up Copilot instructions
2 participants