Skip to content

Conversation

@vladimirp5
Copy link

@vladimirp5 vladimirp5 commented Oct 21, 2025

Description

  1. Converted the developer guidelines to markdown
  2. Referenced it into the copilot-instructions.md
  3. Split away JS/TS rules into a different document and referenced it into copilot-instructions.md

References:

https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review

Link to JIRA or Confluence

[The link/links to one or more JIRA ticket/Confluence page]

Impact

[Discuss the impact of your changes on the project. This might include effects on performance, new dependencies, or changes in behaviour.]

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have extended current unit tests suite.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings or new Sonar issues

Does this version change anything in the API dependencies of the app

[Enumerate the API dependencies that are modified in the implementation. Eg: /api/v3/service/route changed to /api/v4/service/route]

New API versions and/or routes added or removed by this PR

[Enumerate or link the file containing the API routes that are removed/added by the PR]

DCLD configuration

[Any DCLD configuration that reviewers should be aware of.]

Additional Information

[Any additional information that reviewers should be aware of.]

@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:17
Copy link

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 organization-level Copilot instructions to enforce clean code guidelines during code reviews. The changes introduce a comprehensive clean code reference document and configure GitHub Copilot to use it.

  • Adds a detailed clean code guidelines document covering comments, functions, naming, testing, security, and commits
  • Creates Copilot instructions that reference the clean code guidelines for code reviews

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/clean-code-guidelines.md New comprehensive clean code guidelines document with examples in JavaScript/TypeScript, C#, and C++
.github/copilot-instructions.md Configures GitHub Copilot to apply clean code guidelines during code reviews

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

@vladimirp5 vladimirp5 requested review from a team and imanzarrabian October 21, 2025 07:19
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:19
Copy link

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:20
Copy link

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:21
Copy link

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:22
Copy link

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:24
Copy link

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


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

@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:30
Copy link

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.


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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:31
Copy link

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


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

@vladimirp5 vladimirp5 requested a review from Copilot October 21, 2025 07:33
Copy link

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


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

@vladimirp5 vladimirp5 requested a review from JamesCo76 October 21, 2025 09:13
@@ -0,0 +1,5 @@
Exclude from review files matching the glob pattern `*test*/**`.

Choose a reason for hiding this comment

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

Should we give it a try to list dependencies used in every repo?

Choose a reason for hiding this comment

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

something like : Extract and list from the code all APIs consumed in the code with their versions. Do not include the API exposed by the code itself, only the external ones used in the app

Choose a reason for hiding this comment

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

we are probably not using same patern for test in all repo

@JamesCo76
Copy link
Contributor

JamesCo76 commented Oct 24, 2025

@vladimirp5 (or anyone else) - if you know, can you please explain to me the overlap or difference between:

  • the organisation-wide custom instructions such as this PR will add
  • the organisation-wide preferences and instructions that can be entered here

They seem like the same feature stored in different locations.

@vladimirp5
Copy link
Author

@vladimirp5 (or anyone else) - if you know, can you please explain to me the overlap or difference between:

  • the organisation-wide custom instructions such as this PR will add
  • the organisation-wide preferences and instructions that can be entered here

They seem like the same feature stored in different locations.

Yes, that's because they are. Adding instructions here from my POV is better because we can track changes.

@JamesCo76
Copy link
Contributor

@vladimirp5 (or anyone else) - if you know, can you please explain to me the overlap or difference between:

  • the organisation-wide custom instructions such as this PR will add
  • the organisation-wide preferences and instructions that can be entered here

They seem like the same feature stored in different locations.

Yes, that's because they are. Adding instructions here from my POV is better because we can track changes.

Gotcha. There are audit logs for the Copilot preferences and the history should be trackable.

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.

5 participants