diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e80cb298..7476b7e6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,34 +1,24 @@ # Contributing Guidelines -We greatly value feedback and contributions from our community. +Thank you for your interest in this project. -Please review this document before submitting any issues or pull requests to ensure we -have all the necessary information to effectively collaborate on your contribution. +We greatly value feedback from the community. -> [!TIP] -If you need help or have questions about using the plugin, please refer to the -[documentation](https://github.com/vmware/packer-plugin-vmware/tree/main/docs) or open -a [discussion][gh-discussions]. - -## Issues - -Use [GitHub issues][gh-issues] to report bugs or suggest enhancements using the -following guidelines. +## Reporting -> [!WARNING] -> Issues that do not follow the guidelines may be closed by the maintainers without -> further investigation. +Please use [GitHub Discussions][gh-discussions] for all triage, ideas, and +general project discussion. -Before opening an issue, please [search existing issues](https://github.com/vmware/packer-plugin-vmware/issues?q=is%3Aissue+is%3Aopen+label%3Abug) -to avoid duplicates. +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. -When opening an issue, use the provided issue form to ensure that you provide all the -necessary details. These details are important for maintainers to understand and -reproduce the issue. +Before opening a discussion, check open and recently closed discussions to make +sure the same thing hasn't already been reported or proposed. > [!IMPORTANT] > - Ensure that you are using a recent version of the plugin. -> - Ensure that you are using a supported version of VMware vSphere. The plugin supports versions in accordance with the [Broadcom Product Lifecycle][product-lifecycle]. +> - Ensure that you are using a supported version of VMware Fusion or VMware Workstation. > [!TIP] > - Learn about [formatting code on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code). @@ -37,57 +27,67 @@ reproduce the issue. ## Pull Requests -Use GitHub pull requests to propose changes to the codebase using the following guidelines. - -> [!WARNING] -> Pull requests that do not follow the guidelines may be closed by the maintainers -> without further review. - -**Before** submitting a pull request, ensure that: - -1. You have [opened a discussion][gh-discussions] to discuss any **significant** work with - the maintainer(s). This ensures that your contribution is aligned with the - project's direction and avoids unnecessary work. -2. You have identified or [open an issue][gh-issues]. This ensures that your contribution - focuses on a specific topic and avoids duplicating effort. -3. You have forked the repository. Refer to the [GitHub documentation][gh-forks] for help. -3. You are working against the latest source on the `main` branch. You may need to - rebase your branch against the latest `main` branch. -4. You have created a topic branch based on `main`. Do not work directly on the `main` branch. -5. You have modified the source based on logical units of work. Focus on the specific change - you are contributing. Pull requests that contain multiple unrelated changes will be - rejected. -4. You have followed the existing style and conventions of the project. -5. You have added tests for your changes. -5. You have generated the updated documentation and associated assets by running `make generate`. -5. You have tested building the plugin by running `make build`. -7. You have tested your changes with a local build of the plugin by running `make dev`. -9. You have verified all new and existing tests are passing by running `make test`. -10. You have used [Conventional Commits][conventional-commits] format for commit messages. -11. You have signed-off and committed your changes [using clear commit messages][git-commit]. - -When opening a pull request, ensure that: - -1. You title your pull request using the [Conventional Commits][conventional-commits] format. -2. You provide a detailed description of the changes in the pull request template. -2. You open any work-in-progress pull requests as a draft. -3. You mark the pull request as ready for review when you are ready for it to be reviewed. -4. You follow the status checks for the pull request to ensure that all checks are passing. -5. You stay involved in the conversation with the maintainers to ensure that your contribution - can be reviewed. - -> [!TIP] -> If you have any questions about the contribution process, open a [discussion][gh-discussions]. +Pull requests are limited to repository collaborators. + +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: + +1. You check existing open, and recently merged, pull requests to make sure + 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. 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. Create a topic branch from the latest `main` branch. +2. Modify the source; please focus on the **specific** change you are + contributing. +3. Follow the existing style and conventions of the project. +4. Add tests for your changes. +5. Generate the updated documentation and associated assets by running + `make generate`. +6. Test building the plugin by running `make build`. +7. Test your changes with a local build of the plugin by running `make dev`. +8. Verify all new and existing tests are passing by running `make test`. +9. Update the documentation, if required. +10. Sign-off and commit your changes + [using a clear commit messages][git-commit]. Use of + [Conventional Commits][conventional-commits] are required. +11. Open a pull request, answering any default questions. +12. Pay attention to any automated failures reported in the pull request, and + stay involved in the conversation. + +GitHub provides additional documentation on +[creating a pull request][gh-pull-requests]. ### Contributor Flow This is an outline of the contributor workflow: +- Create a topic branch from where you want to base your work. +- 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 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. + Example: ```shell -git remote add upstream https://github.com//.git -git checkout -b feat/add-x main +git remote add upstream https://github.com/vmware/packer-plugin-vmware.git +git checkout --branch feat/add-x main git commit --signoff --message "feat: add support for x Added support for x. @@ -99,7 +99,7 @@ git push origin feat/add-x ### Formatting Commit Messages -Follow the conventions on [How to Write a Git Commit Message][git-commit] and use +Follow the conventions on [How to Write a Git Commit Message][git-commit] and [Conventional Commits][conventional-commits]. Be sure to include any related GitHub issue references in the commit message. @@ -116,7 +116,7 @@ Signed-off-by: Jane Doe Ref: #123 ``` -### Stay In Sync With Upstream +### Staying In Sync With Upstream When your branch gets out of sync with the `upstream/main` branch, use the following to update: @@ -147,20 +147,27 @@ If you need to squash changes into an earlier commit, you can use: ```shell git add . git commit --fixup -git rebase --interactive --autosquash upstream/main +git rebase --interactive --autosquash main git push --force-with-lease origin feat/add-x ``` -When resolving review comments, mark the conversation as resolved and note the commit -SHA that addresses the review comment. This helps maintainers verify the issue has been -resolved. +Be sure to add a comment to the pull request indicating your new changes are +ready to review, as GitHub does not generate a notification when you `git push`. + +When resolving review comments, mark the conversation as resolved and note the +commit SHA that addresses the review comment. This helps maintainers verify the +issue has been resolved. + +## Finding Contributions to Work On -Request a review from the maintainers when you are ready for a follow-up review. +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]. [conventional-commits]: https://conventionalcommits.org [gh-discussions]: https://github.com/vmware/packer-plugin-vmware/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/vmware/packer-plugin-vmware/discussions/new?category=triage +[gh-discussions-ideas]: https://github.com/vmware/packer-plugin-vmware/discussions/new?category=ideas [gh-issues]: https://github.com/vmware/packer-plugin-vmware/issues [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 -[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 00000000..3b4a0d64 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,59 @@ +--- +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Before filing an enhancement or feature, please [search the existing discussions](https://github.com/vmware/packer-plugin-vmware/discussions) 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, please include the following information. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: >- + This project has a [Code of Conduct](https://github.com/vmware/packer-plugin-vmware/blob/main/.github/CODE_OF_CONDUCT.md) + that all participants are expected to understand and follow. + options: + - label: I have read and agree to the project's Code of Conduct. + required: true + - label: Vote on this discussion by adding a 👍 [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original description to help the maintainers prioritize. + required: false + - label: Do not leave "+1" or other comments that do not add relevant information or questions. + required: false + - type: textarea + id: description + attributes: + label: Description + description: A written overview of the enhancement or feature. + validations: + required: true + - type: textarea + id: use-case + attributes: + label: Use Case(s) + description: Please provide a use case or scenario. + validations: + required: true + - type: textarea + id: potential-configuration + attributes: + label: Potential Configuration + description: | + Provide a potential Packer configuration. + Learn more about [Quoting Code](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code). + placeholder: | + Please format any code in code blocks using the markdown editor. + validations: + required: true + - type: textarea + id: references + attributes: + label: References + description: | + 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: | + #0000 + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/DISCUSSION_TEMPLATE/triage.yml similarity index 75% rename from .github/ISSUE_TEMPLATE/bug.yml rename to .github/DISCUSSION_TEMPLATE/triage.yml index ad10231d..69b6101c 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/DISCUSSION_TEMPLATE/triage.yml @@ -1,19 +1,12 @@ --- -name: Bug Report -description: Is something not working as expected? Submit a bug. -labels: - - bug - - needs-triage -type: bug -projects: - - vmware/48 +labels: ["bug"] body: - type: markdown attributes: value: | - Before filing an issue, please [search the existing issues](https://github.com/vmware/packer-plugin-vmware/issues?q=is%3Aissue+is%3Aopen+label%3Abug) (open or closed), and use the [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) feature to add up-votes to existing issues. + Before filing, please [search the existing discussions](https://github.com/vmware/packer-plugin-vmware/discussions) (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 threads. - When filing an issue, please include the following information. + When filing, please include the following information. - type: checkboxes id: terms attributes: @@ -22,12 +15,10 @@ body: options: - label: I have read and agree to the [Code of Conduct](https://github.com/vmware/packer-plugin-vmware/blob/main/.github/CODE_OF_CONDUCT.md). required: true - - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue description to help the maintainers prioritize. + - label: Vote on this discussion by adding a 👍 [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original description to help the maintainers prioritize. required: false - label: Do not leave "+1" or other comments that do not add relevant information or questions. required: false - - label: If you are interested in working on this issue or have submitted a pull request, please leave a comment. - required: false - type: input id: packer-version attributes: @@ -95,7 +86,7 @@ body: - Please ensure all secrets and identifiable information is removed. - Please format any code in code blocks using the markdown editor. - Learn more about [Code Formatting](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code). + Learn more about [Quoting Code](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code). placeholder: | Please format any code in code blocks using the markdown editor. validations: @@ -107,7 +98,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: true - type: textarea @@ -115,9 +106,9 @@ body: attributes: label: Panic Output description: | - If the plugin produced a panic, please provide a link to a [GitHub Gist](https://gist.github.com/) containing the output of the `crash.log` + If the plugin produced a panic, please provide a link to a [GitHub Gist](https://gist.github.com/) containing the output of the `crash.log`. placeholder: | - Link to a GitHub Gist. Please do not paste the panic output in the issue. + Link to a GitHub Gist. Please do not paste the panic output in the discussion. validations: required: false - type: textarea @@ -162,9 +153,9 @@ body: attributes: label: References description: | - Please provide any related GitHub issues or pull requests (open or closed) or documentation. - Learn about [Referencing GitHub Issues](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). + 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: | #0000 validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6f23af68..ba1fe538 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ --- blank_issues_enabled: false contact_links: - - name: Community Discussions - url: https://github.com/vmware/packer-plugin-vmware/discussions - about: Need some help? Join the community discussions. + - name: Discussions + url: https://github.com/vmware/packer-plugin-vmware/discussions/new/choose + about: The starting point for questions, assistance, and discussions about this project. - name: Packer Plugin Documentation - url: https://developer.hashicorp.com/packer/integrations/vmware/vmware + url: https://vmware.github.io/packer-plugin-vmware about: Having trouble with this Packer plugin? Check out the plugin documentation. - name: Packer Documentation url: https://developer.hashicorp.com/packer/ diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml deleted file mode 100644 index fa83ec6e..00000000 --- a/.github/ISSUE_TEMPLATE/docs.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Documentation -description: Found a typo or something that needs clarification? -labels: - - documentation - - needs-review -type: task -projects: - - vmware/48 -body: - - type: markdown - attributes: - value: > - When filing a documentation issue, please include the following information. - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: The Code of Conduct applies to you when interacting with the community here on GitHub and contributing code. - options: - - label: I have read and agree to the [Code of Conduct](https://github.com/vmware/packer-plugin-vmware/blob/main/.github/CODE_OF_CONDUCT.md). - required: true - - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue description to help the maintainers prioritize. - required: false - - label: Do not leave "+1" or other comments that do not add relevant information or questions. - required: false - - label: If you are interested in working on this issue or have submitted a pull request, please leave a comment. - required: false - - type: textarea - id: detail - attributes: - label: Detail - description: What part of the documentation needs to be changed? - validations: - required: true - - type: textarea - id: suggestion - attributes: - label: Suggestion - description: How should the documentation be changed to address the issue? - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml deleted file mode 100644 index ceff930c..00000000 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ /dev/null @@ -1,63 +0,0 @@ ---- -name: Enhancement Request -description: Is something critical missing? Suggest an enhancement. -labels: - - enhancement - - needs-review -type: feature -projects: - - vmware/48 -body: - - type: markdown - attributes: - value: > - Before filing an enhancement, please search the existing issues and use the - [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) - feature to add up-votes to existing requests. - - - When filing an enhancement, please include the following information. - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: >- - This project has a [Code of Conduct](https://github.com/vmware/packer-plugin-vmware/blob/main/.github/CODE_OF_CONDUCT.md) - that all participants are expected to understand and follow. - options: - - label: I have read and agree to the project's Code of Conduct. - required: true - - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue description to help the maintainers prioritize. - required: false - - label: Do not leave "+1" or other comments that do not add relevant information or questions. - required: false - - label: If you are interested in working on this issue or have submitted a pull request, please leave a comment. - required: false - - type: textarea - id: description - attributes: - label: Description - description: A written overview of the enhancement. - validations: - required: true - - type: textarea - id: use-case - attributes: - label: Use Case(s) - description: Any relevant use-cases that you see. - validations: - required: true - - type: textarea - id: potential-configuration - attributes: - label: Potential Configuration - description: Provide a potential configuration. - validations: - required: true - - type: textarea - id: references - attributes: - label: References - description: Provide any references. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/reserved.yml b/.github/ISSUE_TEMPLATE/reserved.yml new file mode 100644 index 00000000..a5d07138 --- /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/vmware/packer-plugin-vmware/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 I neglected to read the message above and can expect this item to be closed without review." + required: true diff --git a/docs-site/extra/community/contributing.md b/docs-site/extra/community/contributing.md index e4e478da..add91c6e 100644 --- a/docs-site/extra/community/contributing.md +++ b/docs-site/extra/community/contributing.md @@ -4,68 +4,76 @@ title: Contributing # Contributing Guidelines -We greatly value feedback and contributions from our community. +Thank you for your interest in this project. -Please review this document before submitting any issues or pull requests to ensure we have all the -necessary information to effectively collaborate on your contribution. +We greatly value feedback from the community. --8<-- "community/issues-guidance.md" ## Pull Requests -Use GitHub pull requests to propose changes to the codebase using the following guidelines. - -!!! warning - - Pull requests that do not follow the guidelines may be closed by the maintainers - without further review. - -**Before** submitting a pull request, ensure that: - -1. You have [opened a discussion][gh-discussions] to discuss any **significant** work with - the maintainer(s). This ensures that your contribution is aligned with the - project's direction and avoids unnecessary work. -2. You have identified or [open an issue][gh-issues]. This ensures that your contribution - focuses on a specific topic and avoids duplicating effort. -3. You have forked the repository. Refer to the [GitHub documentation][gh-forks] for help. -3. You are working against the latest source on the `main` branch. You may need to - rebase your branch against the latest `main` branch. -4. You have created a topic branch based on `main`. Do not work directly on the `main` branch. -5. You have modified the source based on logical units of work. Focus on the specific change - you are contributing. Pull requests that contain multiple unrelated changes will be - rejected. -4. You have followed the existing style and conventions of the project. -5. You have added tests for your changes. -5. You have generated the updated documentation and associated assets by running `make generate`. -5. You have tested building the plugin by running `make build`. -7. You have tested your changes with a local build of the plugin by running `make dev`. -9. You have verified all new and existing tests are passing by running `make test`. -10. You have used [Conventional Commits][conventional-commits] format for commit messages. -11. You have signed-off and committed your changes [using clear commit messages][git-commit]. - -When opening a pull request, ensure that: - -1. You title your pull request using the [Conventional Commits][conventional-commits] format. -2. You provide a detailed description of the changes in the pull request template. -2. You open any work-in-progress pull requests as a draft. -3. You mark the pull request as ready for review when you are ready for it to be reviewed. -4. You follow the status checks for the pull request to ensure that all checks are passing. -5. You stay involved in the conversation with the maintainers to ensure that your contribution - can be reviewed. - -!!! tip - - If you have any questions about the contribution process, open a [discussion][gh-discussions]. +Pull requests are limited to repository collaborators. + +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 assist with the collaboration or open the +implementation directly. + +**Before** sending us a pull request, please ensure that: + +1. You check existing open, and recently merged, pull requests to make sure + 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. 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. Create a topic branch from the latest `main` branch. +2. Modify the source; please focus on the **specific** change you are + contributing. +3. Follow the existing style and conventions of the project. +4. Add tests for your changes. +5. Generate the updated documentation and associated assets by running + `make generate`. +6. Test building the plugin by running `make build`. +7. Test your changes with a local build of the plugin by running `make dev`. +8. Verify all new and existing tests are passing by running `make test`. +9. Update the documentation, if required. +10. Sign-off and commit your changes + [using a clear commit messages][git-commit]. Use of + [Conventional Commits][conventional-commits] are required. +11. Open a pull request, answering any default questions. +12. Pay attention to any automated failures reported in the pull request, and + stay involved in the conversation. + +GitHub provides additional documentation on +[creating a pull request][gh-pull-requests]. **Contributor Flow** This is an outline of the contributor workflow: +- Create a topic branch from where you want to base your work. +- 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 your collaborator branch. +- Submit a pull request. If the pull request is a work in progress, open as + draft until ready for review. + +!!! warning + + This project **requires** that commits are signed-off for the Developer Certificate of Origin. + Example: ```shell -git remote add upstream https://github.com//.git -git checkout -b feat/add-x main +git remote add upstream https://github.com/vmware/packer-plugin-vmware.git +git checkout --branch feat/add-x main git commit --signoff --message "feat: add support for x Added support for x. @@ -77,7 +85,7 @@ git push origin feat/add-x **Formatting Commit Messages** -Follow the conventions on [How to Write a Git Commit Message][git-commit] and use +Follow the conventions on [How to Write a Git Commit Message][git-commit] and [Conventional Commits][conventional-commits]. Be sure to include any related GitHub issue references in the commit message. @@ -94,7 +102,7 @@ Signed-off-by: Jane Doe Ref: #123 ``` -**Stay In Sync With Upstream** +**Staying In Sync With Upstream** When your branch gets out of sync with the `upstream/main` branch, use the following to update: @@ -125,20 +133,27 @@ If you need to squash changes into an earlier commit, you can use: ```shell git add . git commit --fixup -git rebase --interactive --autosquash upstream/main +git rebase --interactive --autosquash main git push --force-with-lease origin feat/add-x ``` -When resolving review comments, mark the conversation as resolved and note the commit -SHA that addresses the review comment. This helps maintainers verify the issue has been -resolved. +Be sure to add a comment to the pull request indicating your new changes are +ready to review, as GitHub does not generate a notification when you `git push`. + +When resolving review comments, mark the conversation as resolved and note the +commit SHA that addresses the review comment. This helps maintainers verify the +issue has been resolved. + +**Finding Contributions to Work On** -Request a review from the maintainers when you are ready for a follow-up review. +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]. [conventional-commits]: https://conventionalcommits.org [gh-discussions]: https://github.com/vmware/packer-plugin-vmware/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/vmware/packer-plugin-vmware/discussions/new?category=triage +[gh-discussions-ideas]: https://github.com/vmware/packer-plugin-vmware/discussions/new?category=ideas [gh-issues]: https://github.com/vmware/packer-plugin-vmware/issues [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 -[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle diff --git a/docs-site/extra/community/issues-guidance.md b/docs-site/extra/community/issues-guidance.md index bcc5b5f4..9d07584a 100644 --- a/docs-site/extra/community/issues-guidance.md +++ b/docs-site/extra/community/issues-guidance.md @@ -1,24 +1,19 @@ -## Issues +## Reporting -Use [GitHub issues][gh-issues] to report bugs or suggest enhancements using the -following guidelines. +Please use [GitHub Discussions][gh-discussions] for all triage, ideas, and +general project discussion. -!!! warning - - Issues that do not follow the guidelines may be closed by the maintainers without - further investigation. - -Before opening an issue, please [search existing issues](https://github.com/vmware/packer-plugin-vmware/issues?q=is%3Aissue+is%3Aopen+label%3Abug) -to avoid duplicates. +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. -When opening an issue, use the provided issue form to ensure that you provide all the -necessary details. These details are important for maintainers to understand and -reproduce the issue. +Before opening a discussion, check open and recently closed discussions to make +sure the same thing hasn't already been reported or proposed. !!! warning - Ensure that you are using a recent version of the plugin. - - Ensure that you are using a supported version of VMware vSphere. The plugin supports versions in accordance with the [Broadcom Product Lifecycle][product-lifecycle]. + - Ensure that you are using a supported version of VMware Fusion or VMware Workstation. !!! tip diff --git a/docs-site/extra/community/support.md b/docs-site/extra/community/support.md index 77a44fb0..b0758985 100644 --- a/docs-site/extra/community/support.md +++ b/docs-site/extra/community/support.md @@ -9,9 +9,5 @@ supported by the project maintainers and the plugin community. --8<-- "community/issues-guidance.md" -:lucide-messages-square: You can also start a [discussion][discussions] to ask -questions or share ideas. - -[discussions]: https://github.com/vmware/packer-plugin-vmware/discussions +[gh-discussions]: https://github.com/vmware/packer-plugin-vmware/discussions [gh-issues]: https://github.com/vmware/packer-plugin-vmware/issues -[product-lifecycle]: https://support.broadcom.com/group/ecx/productlifecycle