Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
159 lines (112 loc) · 5.58 KB

CONTRIBUTING.md

File metadata and controls

159 lines (112 loc) · 5.58 KB
Raw

Contributing Guidelines

We greatly value feedback and contributions from our community.

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.

Issues

Use GitHub issues to report bugs or suggest enhancements.

Warning

Issues that do not follow the guidelines may be closed by the maintainers without further investigation.

Before opening an issue, search existing issues to avoid duplicates.

When opening an issue, use the provided issue form and include enough information for maintainers to understand and reproduce the issue.

Warning

Ensure that you are using a recent revision of the project and supported versions of Packer and VMware vSphere.

Pull Requests

Use GitHub pull requests to propose changes to the project.

Before submitting a pull request, ensure that:

  1. You open a discussion to discuss any significant work with the maintainer(s).
  2. You open an issue and link your pull request to the issue for context.
  3. You have forked the repository.
  4. You are working against the latest source on the develop branch.
  5. You have created a topic branch based on develop.
  6. You have focused the pull request on a logical unit of work.
  7. You have followed the existing project style and conventions.
  8. You have updated the documentation when required and run make docs-build.
  9. You have validated the affected templates and tested representative image builds.
  10. You use Conventional Commits and sign off your commits.

When opening a pull request, ensure that:

  1. The title uses Conventional Commits format.
  2. The description answers the questions in the pull request template.
  3. Work-in-progress pull requests are opened as drafts.
  4. All status checks pass.
  5. You stay involved in the conversation with maintainers.

GitHub provides additional documentation on forking a repository and creating a pull request.

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 and are signed-off.
  • Push your changes to the topic branch in your fork.
  • Submit a pull request. If the pull request is a work in progress, please open as draft.

Important

This project requires that commits are signed-off for the Developer Certificate of Origin.

Example:

git remote add upstream https://github.com/<org-name>/<repo-name>.git
git checkout --branch feat/add-x develop
git commit --signoff --message "feat: add support for x
  Added support for x.

  Signed-off-by: Jane Doe <jdoe@example.com>

  Ref: #123"
git push origin feat/add-x

Formatting Commit Messages

We follow the conventions on How to Write a Git Commit Message and Conventional Commits.

Be sure to include any related GitHub issue references in the commit message.

Example:

feat: add support for x

Added support for x.

Signed-off-by: Jane Doe <jdoe@example.com>

Ref: #123

Staying In Sync With Upstream

When your branch gets out of sync with the vmware/develop branch, use the following to update:

git checkout feat/add-x
git fetch --all
git pull --rebase upstream develop
git push --force-with-lease origin feat/add-x

Updating Pull Requests

If your pull request fails to pass or needs changes based on code review, you'll most likely want to squash these changes into existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.

git add .
git commit --amend
git push --force-with-lease origin feat/add-x

If you need to squash changes into an earlier commit, you can use:

git add .
git commit --fixup <commit>
git rebase --interactive --autosquash develop
git push --force-with-lease origin feat/add-x

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.

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.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.