Skip to content

Commit

Permalink
Update clone instructions in README and issue templates
Browse files Browse the repository at this point in the history
Add instructions for cloning the repository using `gh repo clone MicrosoftDocs/PowerShell-Docs` to the `README.md` file.

* **README.md**
  - Add a section for cloning the repository with the `gh repo clone` command.
  - Update the repository structure section to include the `.github/ISSUE_TEMPLATE` directory.

* **Issue Templates**
  - Add a note to the description section of `.github/ISSUE_TEMPLATE/00-bug.yml`, `.github/ISSUE_TEMPLATE/01-article.yml`, `.github/ISSUE_TEMPLATE/02-quality.yml`, `.github/ISSUE_TEMPLATE/03-change.yml`, and `.github/ISSUE_TEMPLATE/04-customer-feedback.yml` to mention the new cloning instructions.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/MicrosoftDocs/PowerShell-Docs?shareId=XXXX-XXXX-XXXX-XXXX).
  • Loading branch information
mustafacco7 committed Oct 16, 2024
1 parent dd153b8 commit 7249961
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/00-bug.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: "🐛 Report a documentation issue"
description: >-
Report an issue with current documentation.
Note: You can clone the repository using `gh repo clone MicrosoftDocs/PowerShell-Docs`.
labels:
- issue-doc-bug
- needs-triage
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/01-article.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: "💡 Suggest a new document or idea"
description: >-
Suggest a new document or major rewrite of an existing one.
Note: You can clone the repository using `gh repo clone MicrosoftDocs/PowerShell-Docs`.
labels:
- issue-doc-idea
- needs-triage
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/02-quality.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: "🦾 Commit to a Quality Contribution"
description: >-
File an issue to take part in the PowerShell Docs Quality Contributions project.
Note: You can clone the repository using `gh repo clone MicrosoftDocs/PowerShell-Docs`.
title: "Quality: "
labels:
- project-quality
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/03-change.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: "🛠 Document a product change"
description: >-
Request documentation for a new or updated feature, cmdlet, parameter, or behavior.
Note: You can clone the repository using `gh repo clone MicrosoftDocs/PowerShell-Docs`.
labels:
- issue-doc-idea
- needs-triage
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/04-customer-feedback.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Feedback"
description: >-
⛔ This template is intended for use by the feedback control on the bottom of every page on the
live site. If you aren't using the feedback control, choose one of the other templates.⛔
Note: You can clone the repository using `gh repo clone MicrosoftDocs/PowerShell-Docs`.
labels:
- "needs-triage"
body:
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][04].
The following list describes the main folders in this repository.

- `.github` - contains configuration settings used by GitHub for this repository
- `.github/ISSUE_TEMPLATE` - contains multiple issue templates
- `.vscode` - contains configuration settings and recommended extensions for Visual Studio Code (VS
Code)
- `assets` - contains downloadable files linked in the documentation
Expand Down Expand Up @@ -57,6 +58,14 @@ The following list describes the main folders in this repository.
> site as well as the updateable help used by PowerShell. The articles in the `docs-conceptual`
> folder are only published to the Docs website.
## Cloning the Repository

To clone the repository, use the following command:

```sh
gh repo clone MicrosoftDocs/PowerShell-Docs
```

## Contributing

We welcome public contributions into this repository via pull requests into the _main_ branch.
Expand Down

0 comments on commit 7249961

Please sign in to comment.