Skip to content

Commit 5beece1

Browse files
Keep community health files with the repository
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 01627bd commit 5beece1

7 files changed

Lines changed: 162 additions & 46 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant 3.0 Code of Conduct
2+
3+
## Our Pledge
4+
5+
We pledge to make our community welcoming, safe, and equitable for all.
6+
7+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
8+
9+
## Encouraged Behaviors
10+
11+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
12+
13+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
14+
15+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
16+
1. Engaging **kindly and honestly** with others.
17+
1. Respecting **different viewpoints** and experiences.
18+
1. **Taking responsibility** for our actions and contributions.
19+
1. Gracefully giving and accepting **constructive feedback**.
20+
1. Committing to **repairing harm** when it occurs.
21+
1. Behaving in other ways that promote and sustain the **well-being of our community**.
22+
23+
## Restricted Behaviors
24+
25+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
26+
27+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
28+
1. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
29+
1. **Stereotyping or discrimination.** Characterizing anyone's personality or behavior on the basis of immutable identities or traits.
30+
1. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
31+
1. **Violating confidentiality.** Sharing or acting on someone's personal or private information without their permission.
32+
1. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
33+
1. Behaving in other ways that **threaten the well-being** of our community.
34+
35+
### Other Restrictions
36+
37+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
38+
1. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
39+
1. **Promotional materials.** Sharing marketing or other commercial content in a way that is outside the norms of the community.
40+
1. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
41+
42+
## Reporting an Issue
43+
44+
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.
45+
46+
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).
47+
48+
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.
49+
50+
## Addressing and Repairing Harm
51+
52+
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.
53+
54+
1. Warning
55+
1. Event: A violation involving a single incident or series of incidents.
56+
1. Consequence: A private, written warning from the Community Moderators.
57+
1. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
58+
1. Temporarily Limited Activities
59+
1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
60+
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.
61+
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.
62+
1. Temporary Suspension
63+
1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
64+
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.
65+
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.
66+
1. Permanent Ban
67+
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.
68+
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.
69+
1. Repair: There is no possible repair in cases of this severity.
70+
71+
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.
72+
73+
## Scope
74+
75+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
76+
77+
## Attribution
78+
79+
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/).
80+
81+
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/).
82+
83+
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).

.github/CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing
2+
3+
Thank you for investing your time in contributing to this module.
4+
Read the [Code of Conduct](CODE_OF_CONDUCT.md) before participating, and read
5+
[`AGENTS.md`](../AGENTS.md) for the full guidance chain and documentation references.
6+
7+
## Before you start
8+
9+
1. Read [`README.md`](../README.md) to understand what the module does.
10+
2. Familiarize yourself with the [repository standard](https://psmodule.io/Process-PSModule/reference/repository-standard/).
11+
3. Check the open issues and pull requests to avoid duplicate work.
12+
13+
## Workflow
14+
15+
This project follows the [MSX contribution workflow](https://msx.no/docs/Ways-of-Working/Contribution-Workflow/):
16+
17+
1. Open or pick up an issue that describes the change.
18+
2. Create a branch from `main` following the `<type>/<issue>-<short-slug>` convention.
19+
3. Make small, focused commits and push often.
20+
4. Open a **draft pull request** as soon as the change has a basic shape.
21+
5. Run the **Copilot review loop** until it reports a clean round. File an issue for out-of-scope findings.
22+
6. Mark the pull request ready for review and enable auto-merge.
23+
24+
For branching details, see [Branching and Merging](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/).
25+
26+
## Pull requests
27+
28+
- Keep pull requests small and focused on a single deliverable.
29+
- Follow the [commit conventions](https://msx.no/docs/Ways-of-Working/Commit-Conventions/).
30+
- Follow the [pull request format](https://msx.no/docs/Ways-of-Working/PR-Format/).
31+
32+
## Issues
33+
34+
Use GitHub Issues to report bugs, request features, or propose improvements.
35+
Follow the [issue format](https://msx.no/docs/Ways-of-Working/Issues/Process/Format/).
36+
37+
## Code standards
38+
39+
PowerShell in this module follows the
40+
[PSModule PowerShell module standard](https://psmodule.io/Process-PSModule/reference/powershell-module-standard/)
41+
and the [MSX coding standards](https://msx.no/docs/Coding-Standards/).
42+
43+
## Questions
44+
45+
Follow the repository's [support guidance](SUPPORT.md).

.github/SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
Only the latest release is supported. Security fixes are released only for the latest version.
6+
7+
## Reporting a vulnerability
8+
9+
Do not disclose a suspected or confirmed vulnerability through a public issue, pull request, or discussion.
10+
11+
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).
12+
13+
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.
14+
15+
We handle reports privately, investigate them, and coordinate a fix and disclosure with the reporter where possible.

.github/SUPPORT.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Support
2+
3+
## PSModule support
4+
5+
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.
6+
7+
For matters that are not suitable for a public issue, contact [psmodule@psmodule.io](mailto:psmodule@psmodule.io).
8+
9+
To contribute, see the repository's [contributing guide](CONTRIBUTING.md).
10+
11+
## Security vulnerabilities
12+
13+
Do not report security vulnerabilities through GitHub Issues. Follow the repository's [security policy](SECURITY.md) instead.
14+
15+
## PowerShell Gallery support
16+
17+
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).

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If you find a problem or improvement, fix if small; otherwise open an issue.
88
## Repo guidance
99

1010
- [`README.md`](README.md) — what this repository is and its purpose as a template.
11-
- [`CONTRIBUTING.md`](CONTRIBUTING.md) — how to contribute to this repository.
11+
- [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md) — how to contribute to this repository.
1212

1313
## PSModule Framework guidance
1414

CONTRIBUTING.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ Modules built from this template use the [PSModule framework](https://github.com
2525

2626
## Contributing
2727

28-
To contribute to this template itself, read the [Contribution guidelines](CONTRIBUTING.md).
28+
To contribute to this template itself, read the [contribution guidelines](.github/CONTRIBUTING.md).
2929
For agents and AI tools, start with [`AGENTS.md`](AGENTS.md).

0 commit comments

Comments
 (0)