| title | owner |
|---|---|
Contributing guide to Tile Developer documentation |
Services |
The Tile Developer documentation project established the Developer Certificate of Origin requirement for all contributions to this repository. Submitted content must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
This is an outline of what a contributor's workflow looks such as:
- Create a topic branch from where you want to base your work
- Make commits of logical units
- Make sure that your commit messages are in the proper format (see below)
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request
Example:
git remote add upstream https://github.com/vmware/@(project).git
git checkout -b my-new-feature main
git commit -a
git push origin my-new-featureIf your PR fails to pass CI or needs changes based on code review, squashing 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 amend the commit.
Always add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a notification when you Git push.
VMware follow the conventions on Conventional Commits and How to Write a Git Commit Message.
Always include any related GitHub problem references in the commit message. See GFM syntax for referencing problems and commits.