From 41640d76ef02d3865429438aa356d96c3c321e03 Mon Sep 17 00:00:00 2001 From: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Date: Mon, 21 Jul 2025 17:38:16 +0100 Subject: [PATCH 1/4] Remove layout 'inline' (#56743) --- .../actions/concepts/runners/about-actions-runner-controller.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/actions/concepts/runners/about-actions-runner-controller.md b/content/actions/concepts/runners/about-actions-runner-controller.md index eced742cc958..02a778de4696 100644 --- a/content/actions/concepts/runners/about-actions-runner-controller.md +++ b/content/actions/concepts/runners/about-actions-runner-controller.md @@ -2,7 +2,6 @@ title: About Actions Runner Controller shortTitle: About ARC intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' -layout: inline versions: fpt: '*' ghec: '*' From 24894d336543fa158b4a8a2f73b82ac2a620d196 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 21 Jul 2025 10:09:26 -0700 Subject: [PATCH 2/4] Update links to internal docs (#55114) Co-authored-by: Kevin Heis From 1b5cdf91f116444b97497cebe015c77e2d91e5f8 Mon Sep 17 00:00:00 2001 From: Christopher Harrison Date: Mon, 21 Jul 2025 10:21:19 -0700 Subject: [PATCH 3/4] Added example of copilot instructions (#56669) Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: John Clement <70238417+jclement136@users.noreply.github.com> --- ...-custom-instructions-for-github-copilot.md | 61 +++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md index bb4f5ee9f929..39989107111d 100644 --- a/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md @@ -220,6 +220,67 @@ Did you successfully add a custom instructions file to your repository? {% endnote %} +## Writing effective repository custom instructions + +The instructions you add to the `.github/copilot-instructions.md` file should be short, self-contained statements that provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository. + +The exact structure you utilize for your instructions file will vary by project and need, but the following guidelines provide a good starting point: + +* Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information. +* Include the folder structure of the repository, including any important directories or files that are relevant to the project. +* Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices. +* Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations. + +The following instructions file is an example of these practices in action: + +```markdown +# Project Overview + +This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage. + +## Folder Structure + +- `/src`: Contains the source code for the frontend. +- `/server`: Contains the source code for the Node.js backend. +- `/docs`: Contains documentation for the project, including API specifications and user guides. + +## Libraries and Frameworks + +- React and Tailwind CSS for the frontend. +- Node.js and Express for the backend. +- MongoDB for data storage. + +## Coding Standards + +- Use semicolons at the end of each statement. +- Use single quotes for strings. +- Use function based components in React. +- Use arrow functions for callbacks. + +## UI guidelines + +- A toggle is provided to switch between light and dark mode. +- Application should have a modern and clean design. +``` + +You should also consider the size and complexity of your repository. The following types of instructions may work for a small repository with only a few contributors, but for a large and diverse repository, **these may cause problems**: + +* Requests to refer to external resources when formulating a response +* Instructions to answer in a particular style +* Requests to always respond with a certain level of detail + +For example, the following instructions **may not have the intended results**: + +```markdown +Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code. + +Use @terminal when answering questions about Git. + +Answer all questions in the style of a friendly colleague, using informal language. + +Answer all questions in less than 1000 characters, and words of no more than 12 characters. +``` + ## Repository custom instructions in use The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.copilot.copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically added to requests that you submit to {% data variables.product.prodname_copilot_short %} in the context of that repository. For example, they are added to the prompt you submit to {% data variables.copilot.copilot_chat_short %}. From a4b7767796cacace3f258a02fc54e1024c1216f5 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 21 Jul 2025 19:04:12 +0100 Subject: [PATCH 4/4] Aim to fix output for stale action (#56747) Co-authored-by: Kevin Heis --- .github/workflows/needs-sme-stale-check.yaml | 5 +++-- .github/workflows/no-response.yaml | 4 ++-- .github/workflows/stale.yml | 9 +++++++-- .github/workflows/triage-stale-check.yml | 4 ++-- 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/.github/workflows/needs-sme-stale-check.yaml b/.github/workflows/needs-sme-stale-check.yaml index faf2dcd70147..8092c3909d50 100644 --- a/.github/workflows/needs-sme-stale-check.yaml +++ b/.github/workflows/needs-sme-stale-check.yaml @@ -29,8 +29,9 @@ jobs: stale-pr-message: 'This is a gentle reminder for the docs team that this PR is waiting for technical review by a subject matter expert.' stale-pr-label: 'Waiting on SME review' days-before-pr-close: -1 # never close - staled-issues-prs: true # report issues and PRs that were commented on as stale in the output - closed-issues-prs: true # report issues and PRs that were closed in the output - should always be `0` for this workflow + + - name: Print outputs + run: echo "Staled issues/PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed issues/PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}" - name: Check out repo if: ${{ failure() }} diff --git a/.github/workflows/no-response.yaml b/.github/workflows/no-response.yaml index 9e00daf4da9c..db91a8660658 100644 --- a/.github/workflows/no-response.yaml +++ b/.github/workflows/no-response.yaml @@ -52,8 +52,8 @@ jobs: if you have the information we requested, or open an [issue](https://github.com/github/docs/issues/new/choose) to describe your changes. Then we can reopen this PR and begin the review process. - staled-issues-prs: true # report issues and PRs that were commented on as stale in the output - closed-issues-prs: true # report issues and PRs that were closed in the output + - name: Print outputs + run: echo "Staled issues/PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed issues/PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}" - name: Check out repo if: ${{ failure() }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 56a51057aa19..1eaf9bf6ea02 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -7,10 +7,14 @@ name: Stale check for stalled pull requests in the docs-internal repository on: schedule: - cron: '20 16 * * 1' # Run each Monday at 16:20 UTC / 8:20 PST + push: + paths: + - .github/workflows/stale.yml permissions: contents: read pull-requests: write + issues: write jobs: stale: @@ -28,8 +32,9 @@ jobs: close-pr-label: 'Closed as inactive' operations-per-run: 150 - staled-issues-prs: true # report PRs that were commented on as stale in the output - closed-issues-prs: true # report PRs that were closed in the output + + - name: Print outputs + run: echo "Staled PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}" - name: Check out repo if: ${{ failure() }} diff --git a/.github/workflows/triage-stale-check.yml b/.github/workflows/triage-stale-check.yml index b7b04fb6cac9..c2b93c5c7cf5 100644 --- a/.github/workflows/triage-stale-check.yml +++ b/.github/workflows/triage-stale-check.yml @@ -67,8 +67,8 @@ jobs: stale-pr-message: 'This is a gentle reminder for the docs team that this pull request is waiting for review.' stale-pr-label: 'Waiting on Docs team review' - staled-issues-prs: true # report issues and PRs that were commented on as stale in the output - closed-issues-prs: true # report issues and PRs that were closed in the output + - name: Print outputs + run: echo "Staled issues/PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed issues/PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}" - name: Check out repo if: ${{ failure() }}