Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jul 1, 2025

This PR implements comprehensive GitHub Copilot instructions specifically tailored for the DendroDocs.Shared library, following the established pattern from the dotnet-client-lib repository.

Changes Made

  • Added .github/copilot-instructions.md with comprehensive guidelines for GitHub Copilot contributions
  • Adapted content specifically for DendroDocs.Shared including:
    • Extension methods in DendroDocs.Extensions namespace
    • Data models (TypeDescription, MethodDescription, PropertyDescription, etc.)
    • JSON utilities in DendroDocs.Json namespace
    • Documentation comments parsing patterns
    • Statement models and control flow representations

Key Guidelines Included

Code Style & Conventions

  • Modern C# patterns (null checking with is null, pattern matching)
  • Parameter validation with ArgumentNullException.ThrowIfNull()
  • Code organization following established namespace structure

Build System

  • NUKE build system usage and available targets
  • GitVersion requirements with full git history
  • MSTest testing framework with Shouldly assertions

Project-Specific Patterns

// Extension method pattern
public static string ClassName(this string fullTypeName)
{
    ArgumentNullException.ThrowIfNull(fullTypeName);
    var lastDot = fullTypeName.LastIndexOf('.');
    return lastDot >= 0 ? fullTypeName[(lastDot + 1)..] : fullTypeName;
}

// JSON serialization pattern
var serializerSettings = JsonDefaults.SerializerSettings();
var result = JsonConvert.SerializeObject(types.OrderBy(t => t.FullName), serializerSettings);

Git Workflow

  • Linear commit history preferences
  • Descriptive commit message guidelines
  • Pull request best practices

The instructions ensure consistent, high-quality contributions that align with the DendroDocs.Shared library's architecture and coding standards.

Fixes #45.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@eNeRGy164 eNeRGy164 added the workflow Changes related to the project's pipeline, automation, or CI/CD workflows. label Jul 1, 2025
Co-authored-by: eNeRGy164 <10671831+eNeRGy164@users.noreply.github.com>
Copilot AI changed the title [WIP] Add comprehensive GitHub Copilot instructions Add comprehensive GitHub Copilot instructions for DendroDocs.Shared Jul 1, 2025
Copilot AI requested a review from eNeRGy164 July 1, 2025 07:57
Copilot finished work on behalf of eNeRGy164 July 1, 2025 07:57
@eNeRGy164 eNeRGy164 marked this pull request as ready for review July 1, 2025 08:04
Copilot AI review requested due to automatic review settings July 1, 2025 08:04
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 a new GitHub Copilot instruction document tailored for the DendroDocs.Shared library, outlining coding conventions, build processes, and project-specific patterns.

  • Introduces .github/copilot-instructions.md with guidelines on code style, build system, testing, and workflow
  • Details project-specific patterns for extension methods, data models, JSON utilities, and documentation parsing
  • Specifies GitVersion, NUKE build targets, commit history, and testing frameworks
Comments suppressed due to low confidence (1)

.github/copilot-instructions.md:1

  • [nitpick] Consider adding a table of contents after the title to improve navigation through this long guideline document.
# GitHub Copilot Instructions for DendroDocs.Shared

@coveralls
Copy link

Pull Request Test Coverage Report for Build 15993329326

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 96.104%

Totals Coverage Status
Change from base Build 15905063830: 0.0%
Covered Lines: 567
Relevant Lines: 572

💛 - Coveralls

@coveralls
Copy link

Pull Request Test Coverage Report for Build 15993329323

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 96.104%

Totals Coverage Status
Change from base Build 15905063830: 0.0%
Covered Lines: 567
Relevant Lines: 572

💛 - Coveralls

@eNeRGy164 eNeRGy164 merged commit 794903b into main Jul 1, 2025
3 checks passed
@eNeRGy164 eNeRGy164 deleted the copilot/fix-45 branch July 1, 2025 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

workflow Changes related to the project's pipeline, automation, or CI/CD workflows.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add comprehensive GitHub Copilot instructions

3 participants