Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 25, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Workleap.ComponentModel.DataAnnotations repository.

What's Included

The instructions cover all essential aspects of development in this codebase:

Environment Setup

  • Exact .NET SDK 9.0.304 and runtime 8.0.12 installation commands
  • Proper PATH configuration for the .NET toolchain
  • Multi-target framework considerations (net462, net8.0, netstandard2.0)

Build and Test Workflow

  • Complete build sequence with measured timings (clean: ~1.6s, build: ~7.8s, test: ~2.6s)
  • Critical timeout recommendations with "NEVER CANCEL" warnings
  • Debug configuration usage (Release builds fail due to GitVersion requirements)
  • Integration with dotnet format for code formatting and linting

Validation Guidelines

  • Testing strategy for 220 xUnit tests covering all data annotation attributes
  • Practical validation examples demonstrating attribute usage:
    var person = new Person { Id = "invalid-guid", Name = "" };
    var context = new ValidationContext(person);
    var results = new List<ValidationResult>();
    var isValid = Validator.TryValidateObject(person, context, results, validateAllProperties: true);

Repository Knowledge

  • Project structure and key components
  • Data annotation attribute examples ([Guid], [NotEmpty], [ValidateProperties], etc.)
  • CI/CD integration notes and error recovery procedures
  • Public API compatibility tracking requirements

Validation

All commands and procedures in the instructions have been exhaustively tested to ensure they work correctly. The instructions follow the imperative tone requirement and include specific timing expectations to prevent premature command cancellation.

This enables coding agents to work efficiently in the codebase without extensive exploration or trial-and-error, significantly reducing development friction and improving code quality.

Fixes #122.


💡 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 in the docs.

Copilot AI and others added 2 commits August 25, 2025 15:06
Co-authored-by: Gcaya <8711024+Gcaya@users.noreply.github.com>
…usage

Co-authored-by: Gcaya <8711024+Gcaya@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for development workflow Aug 25, 2025
Copilot AI requested a review from Gcaya August 25, 2025 15:09
@Gcaya Gcaya marked this pull request as ready for review August 26, 2025 12:15
@Gcaya Gcaya requested review from a team and Copilot August 26, 2025 12:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive GitHub Copilot instructions to improve development workflow efficiency in the Workleap.ComponentModel.DataAnnotations repository. The instructions provide detailed guidance on environment setup, build processes, testing procedures, and repository structure to help coding agents work effectively without extensive exploration.

  • Removes BOM (Byte Order Mark) characters from C# source files across the codebase
  • Adds detailed copilot-instructions.md file with complete development workflow guidance
  • Provides specific .NET SDK requirements, build sequences, and validation procedures

Reviewed Changes

Copilot reviewed 18 out of 22 changed files in this pull request and generated 3 comments.

File Description
Multiple .cs files Remove BOM characters from file headers
.github/copilot-instructions.md Add comprehensive development instructions for GitHub Copilot

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

meziantou
meziantou previously approved these changes Aug 26, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Gcaya Gcaya merged commit 877c659 into main Aug 26, 2025
4 of 6 checks passed
@Gcaya Gcaya deleted the copilot/fix-122 branch August 26, 2025 19:43
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

3 participants