Skip to content

Commit 62cc988

Browse files
authored
Merge pull request #39419 from github/repo-sync
Repo sync
2 parents ddc885f + a4b7767 commit 62cc988

File tree

6 files changed

+75
-9
lines changed

6 files changed

+75
-9
lines changed

.github/workflows/needs-sme-stale-check.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ jobs:
2929
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.'
3030
stale-pr-label: 'Waiting on SME review'
3131
days-before-pr-close: -1 # never close
32-
staled-issues-prs: true # report issues and PRs that were commented on as stale in the output
33-
closed-issues-prs: true # report issues and PRs that were closed in the output - should always be `0` for this workflow
32+
33+
- name: Print outputs
34+
run: echo "Staled issues/PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed issues/PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}"
3435

3536
- name: Check out repo
3637
if: ${{ failure() }}

.github/workflows/no-response.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ jobs:
5252
if you have the information we requested, or open an [issue](https://github.com/github/docs/issues/new/choose)
5353
to describe your changes. Then we can reopen this PR and begin the review process.
5454
55-
staled-issues-prs: true # report issues and PRs that were commented on as stale in the output
56-
closed-issues-prs: true # report issues and PRs that were closed in the output
55+
- name: Print outputs
56+
run: echo "Staled issues/PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed issues/PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}"
5757

5858
- name: Check out repo
5959
if: ${{ failure() }}

.github/workflows/stale.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@ name: Stale check for stalled pull requests in the docs-internal repository
77
on:
88
schedule:
99
- cron: '20 16 * * 1' # Run each Monday at 16:20 UTC / 8:20 PST
10+
push:
11+
paths:
12+
- .github/workflows/stale.yml
1013

1114
permissions:
1215
contents: read
1316
pull-requests: write
17+
issues: write
1418

1519
jobs:
1620
stale:
@@ -28,8 +32,9 @@ jobs:
2832
close-pr-label: 'Closed as inactive'
2933

3034
operations-per-run: 150
31-
staled-issues-prs: true # report PRs that were commented on as stale in the output
32-
closed-issues-prs: true # report PRs that were closed in the output
35+
36+
- name: Print outputs
37+
run: echo "Staled PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}"
3338

3439
- name: Check out repo
3540
if: ${{ failure() }}

.github/workflows/triage-stale-check.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ jobs:
6767
stale-pr-message: 'This is a gentle reminder for the docs team that this pull request is waiting for review.'
6868
stale-pr-label: 'Waiting on Docs team review'
6969

70-
staled-issues-prs: true # report issues and PRs that were commented on as stale in the output
71-
closed-issues-prs: true # report issues and PRs that were closed in the output
70+
- name: Print outputs
71+
run: echo "Staled issues/PRs:${{ steps.stale.outputs.staled-issues-prs || '0' }}, Closed issues/PRs:${{ steps.stale.outputs.closed-issues-prs || '0' }}"
7272

7373
- name: Check out repo
7474
if: ${{ failure() }}

content/actions/concepts/runners/about-actions-runner-controller.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: About Actions Runner Controller
33
shortTitle: About ARC
44
intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.'
5-
layout: inline
65
versions:
76
fpt: '*'
87
ghec: '*'

content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,67 @@ Did you successfully add a custom instructions file to your repository?
220220

221221
{% endnote %}
222222

223+
## Writing effective repository custom instructions
224+
225+
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.
226+
227+
The exact structure you utilize for your instructions file will vary by project and need, but the following guidelines provide a good starting point:
228+
229+
* Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information.
230+
* Include the folder structure of the repository, including any important directories or files that are relevant to the project.
231+
* Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices.
232+
* Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations.
233+
234+
The following instructions file is an example of these practices in action:
235+
236+
```markdown
237+
# Project Overview
238+
239+
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.
240+
241+
## Folder Structure
242+
243+
- `/src`: Contains the source code for the frontend.
244+
- `/server`: Contains the source code for the Node.js backend.
245+
- `/docs`: Contains documentation for the project, including API specifications and user guides.
246+
247+
## Libraries and Frameworks
248+
249+
- React and Tailwind CSS for the frontend.
250+
- Node.js and Express for the backend.
251+
- MongoDB for data storage.
252+
253+
## Coding Standards
254+
255+
- Use semicolons at the end of each statement.
256+
- Use single quotes for strings.
257+
- Use function based components in React.
258+
- Use arrow functions for callbacks.
259+
260+
## UI guidelines
261+
262+
- A toggle is provided to switch between light and dark mode.
263+
- Application should have a modern and clean design.
264+
```
265+
266+
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**:
267+
268+
* Requests to refer to external resources when formulating a response
269+
* Instructions to answer in a particular style
270+
* Requests to always respond with a certain level of detail
271+
272+
For example, the following instructions **may not have the intended results**:
273+
274+
```markdown
275+
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
276+
277+
Use @terminal when answering questions about Git.
278+
279+
Answer all questions in the style of a friendly colleague, using informal language.
280+
281+
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
282+
```
283+
223284
## Repository custom instructions in use
224285

225286
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 %}.

0 commit comments

Comments
 (0)