Improve precomposed asset installation commit and PR messages #647
Conversation
This file contains hidden or 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
In order to facilitate asset installation, the installation instructions include precomposed commit and pull request messages, which can be copy and pasted by the installer. The primordial origin of this repository was a collection of reusable GitHub Actions workflows for use in the repositories of Arduino libraries. In those projects, it is not common to make provisions for running the checks locally. For this reason, the precomposed messages in the original installation instructions focused exclusively on the GitHub Actions workflow. The installation instructions in this repository inherited that same focus. However, that approach makes less sense in this context where the primary assets are typically general purpose infrastructure, which may be used locally by the contributor in addition to its used by the companion GitHub Actions workflow. The precomposed commit and PR messages are adjusted to more accurately communicate the true nature of the infrastructure being installed.
per1234
added
topic: documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
In order to facilitate asset installation, the installation instructions include precomposed commit and pull request messages, which can be copy and pasted by the installer.
The primordial origin of this repository was a collection of reusable GitHub Actions workflows for use in the repositories of Arduino libraries. In those projects, it is not common to make provisions for running the checks locally. For this reason, the precomposed messages in the original installation instructions focused exclusively on the GitHub Actions workflow. The installation instructions in this repository inherited that same focus. However, that approach makes less sense in this context where the primary assets are typically general purpose infrastructure, which may be used locally by the contributor in addition to its used by the companion GitHub Actions workflow.
The precomposed commit and PR messages are adjusted to more accurately communicate the true nature of the infrastructure being installed.