Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update clone instructions in README and issue templates #11478

Closed

Conversation

mustafacco7
Copy link

@mustafacco7 mustafacco7 commented Oct 16, 2024

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.

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).
Copy link

Expectations

Thanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it.

To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details.

The docs team begins to review your PR if you request them to or if your PR meets these conditions:

  • It is not a draft PR.
  • It does not have a WIP prefix in the title.
  • It passes validation and build steps.
  • It does not have any merge conflicts.
  • You have checked every box in the PR Checklist, indicating you have completed all required steps and marked your PR as Ready to Merge.

You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge.

While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST).

Copy link
Contributor

Learn Build status updates of commit 7249961:

✅ Validation status: passed

File Status Preview URL Details
.github/ISSUE_TEMPLATE/00-bug.yml ✅Succeeded
.github/ISSUE_TEMPLATE/01-article.yml ✅Succeeded
.github/ISSUE_TEMPLATE/02-quality.yml ✅Succeeded
.github/ISSUE_TEMPLATE/03-change.yml ✅Succeeded
.github/ISSUE_TEMPLATE/04-customer-feedback.yml ✅Succeeded
README.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@sdwheeler
Copy link
Contributor

We don't accept change from external contributors to repo configuration files.

Please read our Contributors Guide: https://learn.microsoft.com/powershell/scripting/community/contributing/pull-requests#avoid-editing-repository-configuration-files

@sdwheeler sdwheeler closed this Oct 16, 2024
@sdwheeler sdwheeler added the code-of-conduct Tag - closed for spam, trolling, or code of conduct violations label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-of-conduct Tag - closed for spam, trolling, or code of conduct violations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants