diff --git a/.github/CODE-OF-CONDUCT.md b/.github/CODE-OF-CONDUCT.md index 23c06fc..51b74e8 100644 --- a/.github/CODE-OF-CONDUCT.md +++ b/.github/CODE-OF-CONDUCT.md @@ -1,132 +1,138 @@ -# Contributor Covenant Code of Conduct +# Code of Conduct ## Our Pledge -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual -identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -- Focusing on what is best not just for us as individuals, but for the overall - community - -Examples of unacceptable behavior include: - -- The use of sexualized language or imagery, and sexual attention or advances of - any kind. -- Trolling, insulting or derogatory comments, and personal or political attacks. -- Public or private harassment. -- Publishing others' private information, such as a physical or email address, - without their explicit permission. -- Other conduct which could reasonably be considered inappropriate in a - professional setting. - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. +We pledge to make our community welcoming, safe, and equitable for all. + +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. + +## Encouraged Behaviors + +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. + +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. +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. +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. +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, +contact [hello@tenthirtyam.org](mailto:hello@tenthirtyam.org). + +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. + +## Addressing and Repairing Harm + +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. + 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. ## Scope -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public 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. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -[hello@tenthirtyam.org][enforcement]. All complaints will be reviewed and -investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of -actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the -community. +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. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][cc], version -[v2.1][cc-v2.1]. - -Community Impact Guidelines were inspired by Mozilla's -[Code of Conduct Enforcement][mozilla-coce] consequence ladder. +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/). -For answers to common questions about this code of conduct, please refer to the -[Frequently Asked Questions][cc-faq]. Translations are available in -[additional languages][cc-translations]. +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/) -[cc]: https://www.contributor-covenant.org -[cc-faq]: https://www.contributor-covenant.org/faq/ -[cc-translations]: https://www.contributor-covenant.org/translations/ -[cc-v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/ -[enforcement]: mailto:hello@tenthirtyam.org?subject=Open%20Source%20Code%20of%20Conduct -[mozilla-coce]: 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/CODEOWNERS b/.github/CODEOWNERS index b50b9f5..0e7ab83 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1,2 @@ +# Default owners for everything in this repository. * @tenthirtyam diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 533a4ce..ee99408 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,31 +1,29 @@ # Contributing Guidelines -Thank you for your interest in contributing to our project. Whether it's a bug -report, new feature, correction, or additional documentation, we greatly value -feedback and contributions from our community. +Thank you for your interest in this project. -Please read through this document before submitting any issues or pull requests -to ensure we have all the necessary information to effectively respond to your -bug report or contribution. +We greatly value feedback from the community. -## Reporting Bugs and Suggesting Enhancements +## Reporting -We welcome you to use the [GitHub issues][gh-issues] to report bugs or suggest -enhancements. +Please use [GitHub Discussions][gh-discussions] for all triage, ideas, and +general project discussion. -When filing an issue, please check existing open, or recently closed, issues to -make sure someone else hasn't already reported. +GitHub Issues are **reserved** for maintainer-tracked work items. Discussions +that turn into confirmed issues or accepted ideas will have a linked issue +created by a maintainer. -Please try to include as much information as you can using the issue fo. Details -like these are incredibly useful: +Before opening a discussion, check open and recently closed discussions to make +sure the same thing hasn't already been reported or proposed. -- A reproducible test case or series of steps. -- Any modifications you've made relevant to the bug. -- Anything unusual about your environment or deployment. +## Pull Requests -## Contributing via Pull Requests +Pull requests are limited to repository collaborators. -Contributions using pull requests are appreciated. +If you are not a collaborator, please use [GitHub Discussions][gh-discussions] +to report issues and propose ideas with the maintainer(s). If a change is +accepted, a maintainer may invite collaboration or open the implementation +directly. **Before** sending us a pull request, please ensure that: @@ -33,25 +31,26 @@ Contributions using pull requests are appreciated. someone else hasn't already addressed the problem. 2. You [open a discussion][gh-discussions] to discuss any significant work with the maintainer(s). -3. You [open an issue][gh-issues] and link your pull request to the issue for - context. Pull requests without an accompanying issue will be closed. -4. You are working against the latest source on the `main` branch. +3. For changes that need tracked follow-up, you reference the relevant + discussion and any maintainer-created issue for context. +4. You have collaborator access to the repository. +5. You are working against the latest source on the `main` branch. To open a pull request, please: -1. Fork the repository. +1. Create a topic branch from the latest `main` branch. 2. Modify the source; please focus on the **specific** change you are contributing. 3. Ensure local tests pass. -4. Updated the documentation, if required. -5. Sign-off and commit to your fork - [using a clear commit messages][git-commit]. Use of +4. Update the documentation, if required. +5. Sign-off and commit your changes + [using a clear commit messages][better-git-commits]. Use of [Conventional Commits][conventional-commits] are required. 6. Open a pull request, answering any default questions. 7. Pay attention to any automated failures reported in the pull request, and stay involved in the conversation. -GitHub provides additional documentation on [forking a repository][gh-forks] and +GitHub provides additional documentation on [creating a pull request][gh-pull-requests]. ### Contributor Flow @@ -62,17 +61,18 @@ This is an outline of the contributor workflow: - Make commits of logical units. - Make sure your commit messages are [in the proper format][conventional-commits] **and** are signed-off. -- Push your changes to the topic branch in your fork. +- Push your changes to your collaborator branch. - Submit a pull request. If the pull request is a work in progress, open as draft until ready for review. -> [!IMPORTANT] This project **requires** that commits are signed-off for the -> [Developer Certificate of Origin][dco]. +> [!IMPORTANT] +> This project **requires** that commits are signed-off for the [Developer Certificate of Origin][dco]. +> Please refer to [Signing Your Git Commits: From Zero to Verified][sign-git-commits] for more information. Example: ```shell -git remote add upstream https://github.com//.git +git remote add upstream https://github.com/tenthirtyam/setup-task.git git checkout --branch feat/add-x main git commit --signoff --message "feat: add support for x Added support for x. @@ -85,7 +85,7 @@ git push origin feat/add-x ### Formatting Commit Messages -We follow the conventions on [How to Write a Git Commit Message][git-commit] and +We follow the conventions on [How to Write a Better Git Commit Message][better-git-commits] and [Conventional Commits][conventional-commits]. Be sure to include any related GitHub issue references in the commit message. @@ -142,16 +142,17 @@ ready to review, as GitHub does not generate a notification when you `git push`. ## Finding Contributions to Work On -Looking at the existing issues is a great way to find something to contribute -on. If you have an idea you'd like to discuss, -[open a discussion][gh-discussions]. +Looking at the existing discussions and maintainer-created issues is a great +way to find something to contribute on. If you have an idea you'd like to +discuss, [open a discussion][gh-discussions]. [dco]: https://probot.github.io/apps/dco/ [conventional-commits]: https://conventionalcommits.org [gh-discussions]: https://github.com/tenthirtyam/setup-task/discussions -[gh-forks]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo +[gh-discussions-triage]: https://github.com/tenthirtyam/setup-task/discussions/new?category=triage +[gh-discussions-ideas]: https://github.com/tenthirtyam/setup-task/discussions/new?category=ideas [gh-issues]: https://github.com/tenthirtyam/setup-task/issues [gh-markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github [gh-pull-requests]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request -[git-commit]: https://cbea.ms/git-commit -[license]: LICENSE +[better-git-commits]: https://tenthirtyam.org/dispatches/2026/03/22/conventional-commits-how-to-write-a-better-git-commit-message/?h=better+git +[sign-git-commits]: https://tenthirtyam.org/dispatches/2026/03/23/signing-your-git-commits-from-zero-to-verified/?h=sign diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml similarity index 68% rename from .github/ISSUE_TEMPLATE/enhancement.yml rename to .github/DISCUSSION_TEMPLATE/ideas.yml index a4ae53d..33544d3 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -1,16 +1,12 @@ --- -name: Enhancement -description: Suggest an enhancement or feature to improve the action. -title: Add support for {{ description }} -labels: [enhancement] -assignees: [tenthirtyam] +labels: ["enhancement"] body: - type: markdown attributes: value: | - Before filing an enhancement or feature, please [search the existing issues](https://github.com/hashicorp/terraform-provider-vsphere/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) for related requests, and use the [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing requests. + Before filing an enhancement or feature, please [search existing discussions](https://github.com/tenthirtyam/setup-task/discussions?discussions_q=is%3Aopen) for related requests, and use the [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing requests. - When filing an enhancement issue, please include the following information. + When filing an ideas discussion, please include the following information. - type: textarea id: description attributes: @@ -41,7 +37,7 @@ body: attributes: label: References description: | - Please provide any related GitHub issues or pull requests (open or closed) or documentation. + Please provide any related GitHub discussions, issues, or pull requests (open or closed) or documentation. Learn about [Referencing Github Issues and Pull Requests](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests). placeholder: | #GH-0000 diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/DISCUSSION_TEMPLATE/triage.yml similarity index 83% rename from .github/ISSUE_TEMPLATE/bug.yml rename to .github/DISCUSSION_TEMPLATE/triage.yml index 5e1ed8a..32c2f39 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/DISCUSSION_TEMPLATE/triage.yml @@ -1,15 +1,12 @@ --- -name: Bug -description: Report a bug or unexpected behavior in the action. -labels: [bug] -assignees: [tenthirtyam] +labels: ["bug"] body: - type: markdown attributes: value: | - Before filing an issue, please [search the existing issues](https://github.com/tenthirtyam/setup-task/issues?q=is%3Aissue+is%3Aopen+label%3Abug) (open or closed), and use the [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing issues. + Before filing, please [search existing discussions](https://github.com/tenthirtyam/setup-task/discussions?discussions_q=is%3Aopen) (open or closed), and use the [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing reports. - When filing an issue, please include the following information. + When filing a triage discussion, please include the following information. - type: input id: version attributes: @@ -59,7 +56,7 @@ body: description: | Please provide a link to a [GitHub Gist](https://gist.github.com/) containing the complete debug output. placeholder: | - Link to a GitHub Gist. Please do not paste the debug output in the issue. + Link to a GitHub Gist. Please do not paste the debug output in the discussion. validations: required: false - type: textarea @@ -90,7 +87,7 @@ body: attributes: label: References description: | - Please provide any related GitHub issues or pull requests (open or closed) or documentation. + Please provide any related GitHub discussions, issues, or pull requests (open or closed) or documentation. Learn about [Referencing Github Issues and Pull Requests](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests). placeholder: | #GH-0000 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8e3bae5..1bc34cf 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,9 @@ +--- blank_issues_enabled: false contact_links: - name: Discussions - url: https://github.com/tenthirtyam/setup-task/discussions - about: Need help with this GitHub Action? Ask a question in Discussions. + url: https://github.com/tenthirtyam/setup-task/discussions/new/choose + about: The starting point for questions, assistance, and discussions about this project. - name: Task Documentation url: https://taskfile.dev about: Need help with Task in general? Check out the Task documentation. diff --git a/.github/ISSUE_TEMPLATE/reserved.yml b/.github/ISSUE_TEMPLATE/reserved.yml new file mode 100644 index 0000000..5bdd2d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/reserved.yml @@ -0,0 +1,18 @@ +--- +name: Reserved +description: Use the GitHub Discussions for questions, assistance, and discussions about this project. +labels: [pending-close] +body: + - type: markdown + attributes: + value: | + > [!IMPORTANT] + > :fire_extinguisher: Do **not** open an issue. + > + > :octocat: Use the [GitHub Discussions](https://github.com/tenthirtyam/setup-task/discussions) for questions, assistance, and discussions about this project. + - type: checkboxes + attributes: + label: Acknowledgement + options: + - label: ":no_good: By submitting this issue, I affirm that neglected to read the message above and can expect this item to be closed without review." + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 76b4cdb..a9466c9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -67,11 +67,12 @@ ### Issue References