Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/needs-sme-stale-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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() }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/no-response.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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() }}
Expand Down
9 changes: 7 additions & 2 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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() }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/triage-stale-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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() }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}.
Expand Down
Loading