diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md new file mode 100644 index 0000000..dba71e9 --- /dev/null +++ b/.claude/CLAUDE.md @@ -0,0 +1 @@ +@../AGENTS.md diff --git a/.gitattributes b/.gitattributes index 96c2e0d..f14e05c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,15 +1,11 @@ -# Needed for publishing of examples, build worker defaults to core.autocrlf=input. -* text eol=autocrlf +* text=auto eol=lf -*.mof text eol=crlf -*.sh text eol=lf -*.svg eol=lf +*.bat text eol=crlf +*.cmd text eol=crlf -# Ensure any exe files are treated as binary -*.exe binary +*.gif binary +*.ico binary +*.jpeg binary *.jpg binary -*.xl* binary -*.pfx binary +*.pdf binary *.png binary -*.dll binary -*.so binary diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 134e9b5..e474975 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,50 +1 @@ -# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners -# Each line is a file pattern followed by one or more owners. - -# These owners will be the default owners for everything in -# the repo. Unless a later match takes precedence, -# @global-owner1 and @global-owner2 will be requested for -# review when someone opens a pull request. -* @PSModule/module-maintainers - -# Order is important; the last matching pattern takes the most -# precedence. When someone opens a pull request that only -# modifies JS files, only @js-owner and not the global -# owner(s) will be requested for a review. -# *.js @js-owner - -# You can also use email addresses if you prefer. They'll be -# used to look up users just like we do for commit author -# emails. -# *.go docs@example.com - -# Teams can be specified as code owners as well. Teams should -# be identified in the format @org/team-name. Teams must have -# explicit write access to the repository. In this example, -# the octocats team in the octo-org organization owns all .txt files. -# *.txt @octo-org/octocats - -# In this example, @doctocat owns any files in the build/logs -# directory at the root of the repository and any of its -# subdirectories. -# /build/logs/ @doctocat - -# The `docs/*` pattern will match files like -# `docs/getting-started.md` but not further nested files like -# `docs/build-app/troubleshooting.md`. -# docs/* docs@example.com - -# In this example, @octocat owns any file in an apps directory -# anywhere in your repository. -# apps/ @octocat - -# In this example, @doctocat owns any file in the `/docs` -# directory in the root of your repository and any of its -# subdirectories. -# /docs/ @doctocat - -# In this example, @octocat owns any file in the `/apps` -# directory in the root of your repository except for the `/apps/github` -# subdirectory, as its owners are left empty. -# /apps/ @octocat -# /apps/github +* @MariusStorhaug diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index b260892..20ab142 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -13,37 +13,37 @@ While acknowledging differences in social norms, we all strive to meet our commu With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: 1. Respecting the **purpose of our community**, our activities, and our ways of gathering. -1. Engaging **kindly and honestly** with others. -1. Respecting **different viewpoints** and experiences. -1. **Taking responsibility** for our actions and contributions. -1. Gracefully giving and accepting **constructive feedback**. -1. Committing to **repairing harm** when it occurs. -1. Behaving in other ways that promote and sustain the **well-being of our community**. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. ## Restricted Behaviors We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. 1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. -1. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. -1. **Stereotyping or discrimination.** Characterizing anyone's personality or behavior on the basis of immutable identities or traits. -1. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. -1. **Violating confidentiality.** Sharing or acting on someone's personal or private information without their permission. -1. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. -1. Behaving in other ways that **threaten the well-being** of our community. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyoneโ€™s personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. ### Other Restrictions 1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. -1. **Failing to credit sources.** Not properly crediting the sources of content you contribute. -1. **Promotional materials.** Sharing marketing or other commercial content in a way that is outside the norms of the community. -1. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. ## Reporting an Issue Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. -When an incident does occur, it is important to report it promptly. To report a possible violation, email [psmodule@psmodule.io](mailto:psmodule@psmodule.io). +When an incident does occur, it is important to report it promptly. To report a possible violation, email [support@psmodule.io](mailto:support@psmodule.io). Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. @@ -51,22 +51,22 @@ Community Moderators take reports of violations seriously and will make every ef If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped. -1. Warning - 1. Event: A violation involving a single incident or series of incidents. - 1. Consequence: A private, written warning from the Community Moderators. - 1. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. -1. Temporarily Limited Activities - 1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. - 1. Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. - 1. Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. -1. Temporary Suspension - 1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. - 1. Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. - 1. Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. -1. Permanent Ban - 1. Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. - 1. Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. - 1. Repair: There is no possible repair in cases of this severity. +1) Warning + 1) Event: A violation involving a single incident or series of incidents. + 2) Consequence: A private, written warning from the Community Moderators. + 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2) Temporarily Limited Activities + 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3) Temporary Suspension + 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4) Permanent Ban + 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3) Repair: There is no possible repair in cases of this severity. This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. @@ -78,6 +78,6 @@ This Code of Conduct applies within all community spaces, and also applies when This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). -Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/). +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) -For answers to common questions about Contributor Covenant, see the [FAQ](https://www.contributor-covenant.org/faq). [Translations](https://www.contributor-covenant.org/translations) are available. Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla's code of conduct team](https://github.com/mozilla/inclusion). +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozillaโ€™s code of conduct team](https://github.com/mozilla/inclusion). diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c64cef8..0646afb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,45 +1,38 @@ - - -# Welcome to PSModule contributing guide - -Thank you for investing your time in contributing to this project! - -Before you get started, please review the following guidelines: -Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. - -In this guide you will get an overview of the contribution workflow from opening an issue to get your contribution published. - -## New contributors - -To get an overview of the project, read the [PSModule readme](../profile/README.md). - -Here are some resources to help you get started with open source contributions: - -- [Finding ways to contribute to open source on GitHub](https://docs.github.com/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) -- [Set up Git](https://docs.github.com/get-started/quickstart/set-up-git) -- [GitHub flow](https://docs.github.com/get-started/quickstart/github-flow) -- [Collaborating with pull requests](https://docs.github.com/github/collaborating-with-pull-requests) - -## Contribution guidelines - -![Contributing flow](../profile/contributionflow.png) - -1. Open an issue or indicate that you want any of the open issues, so others know what you are working on. -1. Fork the repository. -1. Create a branch from `main` and make your changes. - 1. Write the tests showing the desired functionality first. - 1. Write the code that makes the tests pass. -1. Open a pull request towards `upstream/main` as a draft. - - Add any details using the PR template. - - Link the PR to the issue you opened by adding `- Fixes #` so that the issue gets associated and closed with the PR. -1. **Review your own PR first!** When you are happy with it, mark it as "Ready for review". -1. Review and address comments on your pull request. - - We do not want to close PRs directly if we disagree on a specific approach. Lets discuss it instead. We are happy to help you with your changes if there are some difficult points in the code or framework. - - Update your branch with the latest changes from `upstream/main` before your PR is merged. -1. Once your pull request is approved, it will be merged and a new feature will be released immediately. - -> [!IMPORTANT] -> In rare occation we might create a release branch and do a release from that branch, but that is more for bigger changes. -> These branches might also run with a prerelease tag, so that we can test the changes before we release it to the public. +# Contributing + +The affected repository's README and repository-local contribution guidance +define its build, test, and validation steps. Follow those local instructions +before this organization-wide fallback. + +## Before making a change + +- Review the repository's open issues and use the MSX + [issue process](https://msx.no/docs/Ways-of-Working/Issues/) to propose or + claim substantial work. +- Read the repository's code of conduct and applicable PSModule and MSX + standards. +- Keep each change focused on one deliverable. + +## Agent plugins + +The [MSX agent plugin marketplace](https://github.com/MSXOrg/docs/tree/main/.github/plugin) +provides shared standards and workflow skills. The +[PSModule process plugin](https://github.com/PSModule/Process-PSModule/tree/main/.github/plugin) +provides initiative-specific guidance for Process-PSModule repositories. + +## Submit the change + +1. Create a short-lived branch from the repository's default branch. +2. Make the smallest complete change and run the repository's relevant checks. +3. Open a draft pull request and follow the MSX + [PR Format](https://msx.no/docs/Ways-of-Working/PR-Format/). +4. Self-review the diff, request Copilot review explicitly, and address + in-scope feedback. +5. Mark the pull request ready only after it satisfies the repository's review + gate. + +The canonical +[Contribution Workflow](https://msx.no/docs/Ways-of-Working/Contribution-Workflow/) +defines the complete delivery loop. Use the MSX +[Review Etiquette](https://msx.no/docs/Ways-of-Working/Review-Etiquette/) when +giving or responding to feedback. diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 885e6dd..3483bef 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -1,15 +1,26 @@ -# Security Policy +# Security policy ## Supported versions -Only the latest release is supported. Security fixes are released only for the latest version. +Security fixes target the affected repository's latest supported release or, +for an unreleased project, its default branch. Repository-specific security +policies define any additional supported versions and take precedence over this +fallback. ## Reporting a vulnerability -Do not disclose a suspected or confirmed vulnerability through a public issue, pull request, or discussion. +Do not disclose a suspected or confirmed vulnerability through a public issue, +pull request, discussion, or other public channel. -Report the vulnerability through the repository's **Security** tab by creating a private security advisory. If that option is unavailable, email [psmodule@psmodule.io](mailto:psmodule@psmodule.io). +Use the affected repository's **Security** tab to report the vulnerability +privately when private vulnerability reporting is available. If that option is +unavailable, email [security@psmodule.io](mailto:security@psmodule.io). -Include the affected repository and version, a clear description of the vulnerability and its impact, steps to reproduce it, and any proof of concept or suggested mitigation. +Use the same private routes to report accidentally exposed sensitive +information, exposed credentials, exposed secrets, and weak or unsafe security +controls or configurations. -We handle reports privately, investigate them, and coordinate a fix and disclosure with the reporter where possible. +Include the affected repository and version or commit, the vulnerability and +its impact, steps to reproduce it, and any proof of concept or suggested +mitigation. PSModule handles reports privately, investigates them, and +coordinates remediation and disclosure with the reporter. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 7f974ab..e002a6a 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -1,17 +1,24 @@ # Support -## PSModule support +For help with a PSModule repository: -For help with a PSModule repository, open an issue in the GitHub repository for the relevant codebase. Issues let maintainers and other users collaborate on a solution. +1. Read that repository's README and documentation. +2. Search its existing issues for a known answer. +3. Open an issue in the affected repository for a public question. -For matters that are not suitable for a public issue, contact [psmodule@psmodule.io](mailto:psmodule@psmodule.io). +Include the repository and version, relevant environment details, expected and +actual behavior, reproduction steps, and sanitized logs. Remove credentials, +personal information, and other secrets before posting. -To contribute, see the repository's [contributing guide](CONTRIBUTING.md). +Private support matters go to +[support@psmodule.io](mailto:support@psmodule.io). -## Security vulnerabilities +## Sensitive reports -Do not report security vulnerabilities through GitHub Issues. Follow the repository's [security policy](SECURITY.md) instead. +Never report a security vulnerability through a public issue. Follow the +[security policy](SECURITY.md) instead. -## PowerShell Gallery support +Report community conduct concerns through the private route in the +[code of conduct](CODE_OF_CONDUCT.md). -For PowerShell Gallery support, contact [cgadmin@microsoft.com](mailto:cgadmin@microsoft.com) or open an issue in [PowerShell/PowerShellGallery](https://github.com/PowerShell/PowerShellGallery/issues). +To propose a change, follow the [contribution guide](CONTRIBUTING.md). diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..3884664 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1 @@ +Follow the instructions in [AGENTS.md](../AGENTS.md). diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 53188fe..4f05ea7 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,12 +1,8 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - +--- version: 2 updates: - - package-ecosystem: github-actions # See documentation for possible values - directory: / # Location of package manifests + - package-ecosystem: github-actions + directory: / labels: - dependencies - github-actions diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9c3cbd6..13e45de 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,21 +1,18 @@ -## Description + - + -## Type of change +--- +
+Technical details - + -- [ ] ๐Ÿ“– [Docs] -- [ ] ๐Ÿชฒ [Fix] -- [ ] ๐Ÿฉน [Patch] -- [ ] โš ๏ธ [Security fix] -- [ ] ๐Ÿš€ [Feature] -- [ ] ๐ŸŒŸ [Breaking change] +
-## Checklist +
+Relevant issues (or links) - + -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas +
diff --git a/.gitignore b/.gitignore index 456ca0f..0d5ccaf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,18 +1,11 @@ -# VS Code files for those working on multiple tools -.vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json -*.code-workspace - -# Local History for Visual Studio Code -.history/* +# Operating system files +.DS_Store +Thumbs.db -# PSModule framework outputs folder -outputs/* - -# .Net build output -bin/ -obj/ -libs/ +# Editors +.history/ +.idea/ +.vscode/ +*.code-workspace +*.swp +*~ diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..40ab2b5 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,21 @@ +# Agent instructions + +Read nearest first, prefer documentation over memory, and always use the newest +version. + +1. [README.md](README.md) โ€” what this repository provides and how its defaults + are enforced. +2. [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md) โ€” how a change is made + and reviewed. +3. [`PSModule/Process-PSModule`](https://github.com/PSModule/Process-PSModule) โ€” + PSModule process and standards. Start at + [`docs/content/index.md`](https://github.com/PSModule/Process-PSModule/blob/main/docs/content/index.md) + or the [published documentation](https://psmodule.io/Process-PSModule/). + Store a local clone at `~/.psmodule/process-psmodule`. +4. [`MSXOrg/docs`](https://github.com/MSXOrg/docs) โ€” inherited MSX standards. + Start at + [`src/docs/index.md`](https://github.com/MSXOrg/docs/blob/main/src/docs/index.md) + or the [published documentation](https://msx.no/docs/). Store a local clone + at `~/.msxorg/docs`. +5. `github.com/PSModule/memory` (private) โ€” durable lessons from earlier work. + Store a local clone at `~/.psmodule/memory` and read `index.md` last. diff --git a/README.md b/README.md index 1d9d1d8..23bc8a0 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,22 @@ -# .github +# PSModule organization defaults -> Looking for member-only content? See the private [`.github-private`](https://github.com/PSModule/.github-private) repository. +`PSModule/.github` is GitHub's special public repository for the PSModule +organization profile and organization-wide community health defaults. This +repository must remain public for both functions to work. -This is the special `.github` repository for the [PSModule](https://github.com/PSModule) -organization. GitHub gives this repository organization-wide powers: content placed here -can apply to every repository in the organization, so it is far more than just a profile. +## Public organization profile -> [!IMPORTANT] -> This repository must stay **public**. The public organization profile and default -> community health files are not served from a private `.github` repository. Member-only -> content belongs in the private -> [`.github-private`](https://github.com/PSModule/.github-private) repository instead. +The [`profile/README.md`](profile/README.md) file provides the public PSModule +organization profile. -## What it can be used for +## Precedence and enforcement -### Public organization profile +GitHub uses the community health files in this repository when a PSModule +repository does not define its own corresponding file. A repository-local file +takes precedence and remains the enforceable PSModule surface for people, +agents, and automation. -A `profile/README.md` is rendered on the organization's public **Overview** page and is -visible to everyone. Use it for an "About" section, links to key repositories, and -guidance on how to get involved. - -**Read more:** [Customizing your organization's profile](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile) - -### Default community health files - -Files here act as **organization-wide defaults**. Any repository in the organization that -does not provide its own copy inherits the version stored here, so these files can be -maintained in one place. Supported files include: - -| File | Purpose | -| ---- | ------- | -| `CODE_OF_CONDUCT.md` | Standards for how to engage in the community | -| `CONTRIBUTING.md` | How people should contribute | -| `SECURITY.md` | How to report a security vulnerability | -| `SUPPORT.md` | Where to get help | -| `GOVERNANCE.md` | How the project is governed | -| `FUNDING.yml` | Sponsor button shown on repositories | -| `ISSUE_TEMPLATE/` + `config.yml` | Issue templates and the template chooser | -| `PULL_REQUEST_TEMPLATE` / `pull_request_template.md` | Pull request template | -| `DISCUSSION_TEMPLATE/` | Discussion category forms | - -A repository's own file always wins; otherwise GitHub falls back to this repository, -looking in the `.github` folder, then the repository root, then `docs/`. A repository -that defines any of its own issue templates overrides the default `ISSUE_TEMPLATE/` -folder entirely. - -> [!NOTE] -> You cannot set a default `LICENSE` here โ€” license files must live in each repository so -> they are included in clones, packages, and downloads. Any label referenced by a default -> issue template must also exist in the repositories where the template is used. - -**Read more:** [Creating a default community health file](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) - -### Organization workflow (starter) templates - -A `workflow-templates/` folder lets you publish GitHub Actions starter workflows that -members can pick from the **Actions** tab when creating a new workflow. Each template is -a `.yml` file plus a matching `.properties.json` metadata file (and an -optional SVG icon). Use the `$default-branch` placeholder to reference a repository's -default branch. - -**Read more:** [Creating workflow templates for your organization](https://docs.github.com/en/actions/sharing-automations/creating-workflow-templates-for-your-organization) - -### GitHub Copilot customization - -The `.github` folder is the conventional home for the files that tailor how GitHub -Copilot works **within this repository**: - -- `.github/copilot-instructions.md` โ€” repository-wide custom instructions. -- `.github/instructions/*.instructions.md` โ€” path-specific instructions, scoped with an - `applyTo` glob. -- `AGENTS.md` (or a root `CLAUDE.md` / `GEMINI.md`) โ€” agent instructions read by AI - coding agents. -- `.github/workflows/copilot-setup-steps.yml` โ€” preinstalls tools and dependencies for - the Copilot coding agent's environment. - -These files are **repository-scoped**: they guide Copilot when it works on the profile, -community health files, and workflow templates kept here. To apply guidance across every -repository in the organization, set **organization custom instructions** in the -organization's settings instead. - -**Read more:** [Repository custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions) ยท [Organization custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-organization-instructions) - -## Public vs. member-only profile - -| Content | Repository | Visibility | -| ------- | ---------- | ---------- | -| Public organization profile | `.github` (this repository) | Everyone | -| Member-only organization profile | `.github-private` | Organization members | - -Keep public messaging in this repository's `profile/README.md`, and member-only messaging -in the [`.github-private`](https://github.com/PSModule/.github-private) repository's -`profile/README.md`. - -**Read more:** [Customizing your organization's profile](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile) +See GitHub's guides to +[organization profiles](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile) +and +[default community health files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file).