Skip to content

Conversation

@RyanCavanaugh
Copy link
Member

Let's help the robot help itself

Copilot AI review requested due to automatic review settings June 25, 2025 16:09
@github-project-automation github-project-automation bot moved this to Not started in PR Backlog Jun 25, 2025
@typescript-bot typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Jun 25, 2025
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 refines the Copilot guide by renaming the title, adding a new debugging tips section, and reminding contributors to verify line endings.

  • Renames the document header for brevity
  • Introduces a “Debugging Tips” section with console.log patterns
  • Adds a reminder to ensure consistent CRLF line endings
Comments suppressed due to low confidence (3)

.github/copilot-instructions.md:1

  • [nitpick] The new document title is quite generic; consider refining it to reflect the guide’s focus on TypeScript test writing and compiler tests to maintain clarity.
# Guide for Copilot

.github/copilot-instructions.md:287

  • [nitpick] The code fence language specifier ts,diff may not render correctly in Markdown; consider using a standard ts code fence and marking diffs separately for clarity.
```ts,diff

.github/copilot-instructions.md:327

  • The indentation for this bullet appears misaligned, creating an extra nesting level. Align it with the other bullets under “Always format and lint” for consistent formatting.
   - Double-check your line endings. Source files in this repo typically use CRLF line endings. Fix all line endings to be consistent before you wrap up

@github-project-automation github-project-automation bot moved this from Not started to Needs merge in PR Backlog Jun 25, 2025

6. **Always format and lint**
- Don't forget to run `npx hereby lint` and `npx hereby format` before you're done
- Double-check your line endings. Source files in this repo typically use CRLF line endings. Fix all line endings to be consistent before you wrap up
Copy link
Member

Choose a reason for hiding this comment

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

it's annoying that "run the formatter" is not sufficient here

Choose a reason for hiding this comment

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

Are the line endings something that can’t be changed to be same in all files? Or set in gitattributes? You probably would have done it already if it was easy 😅

I know that this document is for Copilot but it’s kinda handy for human developers too. :)

Copy link
Member Author

Choose a reason for hiding this comment

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

We don't set line endings in .gitattributes because we need to have tests that have differing line endings

Copy link
Member

Choose a reason for hiding this comment

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

.gitattributes works like a .gitignore, so theoretically we could scope it, but I don't know how it'll play with things like autocrlf.

Copy link
Member

Choose a reason for hiding this comment

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

That being said, it seems like practically all tooling wants to emit LF, not CRLF (duh), but switching every file over to LF will probably ruin git blame. But maybe the ignore file can handle that kind of change.

@RyanCavanaugh RyanCavanaugh merged commit d6c3ac3 into microsoft:main Jun 25, 2025
32 checks passed
@github-project-automation github-project-automation bot moved this from Needs merge to Done in PR Backlog Jun 25, 2025
@RyanCavanaugh RyanCavanaugh deleted the printf branch June 25, 2025 17:36
@microsoft microsoft locked as resolved and limited conversation to collaborators Jan 7, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants