ARCH-1916 - Update readme with latest contributing guidance

im-open · Aug 31, 2023 · c0cd62c · c0cd62c
1 parent 8a102ca
commit c0cd62c
Showing 1 changed file with 17 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ This template can be used to quickly start a new custom composite-run-steps acti
 - [Example](#example)
 - [Contributing](#contributing)
   - [Incrementing the Version](#incrementing-the-version)
+  - [Source Code Changes](#source-code-changes)
   - [Updating the README.md](#updating-the-readmemd)
 - [Code of Conduct](#code-of-conduct)
 - [License](#license)
@@ -86,18 +87,15 @@ jobs:
 
 ## Contributing
 
-When creating new PRs from a fork please review the following items:
-| PR Contribution Requirements/Tasks                                                                                                                    | Required<br/>for Branches | Required<br/>for Forks |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------:|:----------------------:|
-| The action code does not contain sensitive information.                                                                                               |            Yes            |          Yes           |
-| For major or minor changes, at least one of the commit messages contains the appropriate `+semver:` keywords listed under [Incrementing the Version]. |            Yes            |          Yes           |
-| The README.md action versions have been updated.  See [Updating the README.md] for details.                                                           |            No*            |          Yes           |
+When creating PRs, please review the following guidelines:
 
-\* When a pull request is created from a branch, the build workflow will automatically update the README.md with the next version and push a commit to the branch if those changes have not already been made.
+- [ ] The action code does not contain sensitive information.
+- [ ] At least one of the commit messages contains the appropriate `+semver:` keywords listed under [Incrementing the Version] for major and minor increments.
+- [ ] The README.md has been updated with the latest version of the action.  See [Updating the README.md] for details.
 
 ### Incrementing the Version
 
-This repo uses [git-version-lite] in its build and PR merge workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge.  The following table provides the fragment that should be included in a commit message to active different increment strategies.
+This repo uses [git-version-lite] in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if [source code] changes have been made.  The following table provides the fragment that should be included in a commit message to active different increment strategies.
 
 | Increment Type | Commit Message Fragment                     |
 |----------------|---------------------------------------------|
@@ -107,15 +105,17 @@ This repo uses [git-version-lite] in its build and PR merge workflows to examine
 | minor          | +semver:minor                               |
 | patch          | *default increment type, no comment needed* |
 
-If a contributor is unsure what the next version will be, create a PR and the first build workflow that runs will calculate the value.
+### Source Code Changes
 
-### Updating the README.md
+The files and directories that are considered source code are listed in the `files-with-code` and `dirs-with-code` arguments in both the [build-and-review-pr] and [increment-version-on-merge] workflows.  
+
+If a PR contains source code changes, the README.md should be updated with the latest action version.  The [build-and-review-pr] workflow will ensure these steps are performed when they are required.  The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.
 
-If changes are made to the action's source code, the README.md file should be updated to reflect the next version of the action.  Each instance of the action in the examples should be updated.  This helps users know what the latest tag is without having to navigate to the Tags page of the repository.
+If a PR consists solely of non-source code changes like changes to the `README.md` or workflows under `./.github/workflows`, version updates do not need to be performed.
 
-This step does not need to be completed if only ancillary files like the README.md have been changed.
+### Updating the README.md
 
-If a pull request is made from a branch, this step will be automatically performed by the build workflow unless the PR author has already done so.  Pull requests made from forked repositories will need to perform this step manually.  See [Incrementing the Version] for details on how to determine what the next version will be.
+If changes are made to the action's [source code], the [usage examples] section of this file should be updated with the next version of the action.  Each instance of this action should be updated.  This helps users know what the latest tag is without having to navigate to the Tags page of the repository.  See [Incrementing the Version] for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.
 
 ## Code of Conduct
 
@@ -128,3 +128,7 @@ Copyright &copy; 2023, Extend Health, LLC. Code released under the [MIT license]
 [git-version-lite]: https://github.com/im-open/git-version-lite
 [Incrementing the Version]: #incrementing-the-version
 [Updating the README.md]: #updating-the-readmemd
+[build-and-review-pr]: ./.github/workflows/build-and-review-pr.yml
+[increment-version-on-merge]: ./.github/workflows/increment-version-on-merge.yml
+[source code]: #source-code-changes
+[usage examples]: #usage-examples