docs: in contributing.md include Conventional Commits Specification and the make docs command
#761
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…and make docs command I followed the guidelines in CONTRIBUTING.md, but my PR still failed. So I updated this Doc to include: 1) The `Conventional Commits Specification` 2) The `make docs` command This will allow future contributors to have a better PR experience within our Terraform Provider. Signed-off-by: Walt Ribeiro <[email protected]>
waltribeiro
changed the title
make docs commandmake docs command
ctreatma
reviewed
Aug 26, 2024
displague
reviewed
Sep 25, 2024
Signed-off-by: Marques Johansson <[email protected]>
displague
approved these changes
Sep 25, 2024
|
This PR is included in version 2.6.0 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Earlier, I followed the guidelines in contributing.md but my PR still failed.
Action
I updated this Doc to include:
The Conventional Commits Specification referenced by job log: Validate PR title (pull_request_target)
The
make docscommand referenced by job log: Validate docs (pull_request)Result
This change will inform future contributors, prior to PR, of our submission specs. This will improve the experience within our Terraform Provider.