From a44d6cebf94132aeb0517ebe07a46a04bf2530da Mon Sep 17 00:00:00 2001 From: Sam <109683132+kernelsam@users.noreply.github.com> Date: Tue, 20 Aug 2024 12:59:26 -0700 Subject: [PATCH] cleanup --- CHANGELOG.md | 10 ++++++--- CONTRIBUTING.md | 54 +++++++++++++++++++++++++++++-------------------- action.yaml | 6 +++--- 3 files changed, 42 insertions(+), 28 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 94646dd..aefbf3d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,9 @@ All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -[markdownlint](https://dlaa.me/markdownlint/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +The format is based on [Keep a Changelog], +[markdownlint], +and this project adheres to [Semantic Versioning]. ## [Unreleased] @@ -72,3 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added to 1.0.0 - Install Senzing API on Linux, macOS, and Windows + +[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/ +[markdownlint]: https://dlaa.me/markdownlint/ +[Semantic Versioning]: https://semver.org/spec/v2.0.0.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fe84d2..17336a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,15 +2,15 @@ Welcome to the project! -We encourage contribution in a manner consistent with the [Code of Conduct](CODE_OF_CONDUCT.md). +We encourage contribution in a manner consistent with the [Code of Conduct]. The following will guide you through the process. There are a number of ways you can contribute: -1. [Asking questions](#questions) -1. [Requesting features](#feature-requests) -1. [Reporting bugs](#bug-reporting) -1. [Contributing code or documentation](#contributing-code-or-documentation) +1. [Asking questions] +1. [Requesting features] +1. [Reporting bugs] +1. [Contributing code or documentation] ## License Agreements @@ -23,19 +23,19 @@ A license agreement is not needed for submitting feature request, bug reporting, ### Individual Contributor License Agreement In order to contribute to this repository, an -[Individual Contributor License Agreement (ICLA)](.github/senzing-individual-contributor-license-agreement.pdf) +[Individual Contributor License Agreement (ICLA)] must be completed, submitted and accepted. ### Corporate Contributor License Agreement If the contribution to this repository is on behalf of a company, a -[Corporate Contributor License Agreement (CCLA)](.github/senzing-corporate-contributor-license-agreement.pdf) +[Corporate Contributor License Agreement (CCLA)] must also be completed, submitted and accepted. ### Project License Agreement The license agreement for this repository is stated in the -[LICENSE](LICENSE) file. +[LICENSE] file. ## Questions @@ -50,7 +50,7 @@ TODO: Instead, use ??? All feature requests are "GitHub issues". To request a feature, create a -[GitHub issue](https://help.github.com/articles/creating-an-issue/) +[GitHub issue] in this repository. When creating an issue, there will be a choice to create a "Bug report" or a "Feature request". @@ -59,11 +59,8 @@ Choose "Feature request". ## Bug Reporting All bug reports are "GitHub issues". -Before reporting on a bug, check to see if it has -[already been reported](https://github.com/search?q=+is%3Aissue+user%3Asenzing). -To report a bug, create a -[GitHub issue](https://help.github.com/articles/creating-an-issue/) -in this repository. +Before reporting on a bug, check to see if it has [already been reported]. +To report a bug, create a [GitHub issue] in this repository. When creating an issue, there will be a choice to create a "Bug report" or a "Feature request". Choose "Bug report". @@ -71,8 +68,8 @@ Choose "Bug report". ## Contributing code or documentation To contribute code or documentation to the repository, you must have -[License Agreements](#license-agreements) in place. -This needs to be complete before a [Pull Request](#pull-requests) can be accepted. +[License Agreements] in place. +This needs to be complete before a [Pull Request] can be accepted. ### Setting up a development environment @@ -82,8 +79,8 @@ These variables may be modified, but do not need to be modified. The variables are used throughout the installation procedure. ```console -export GIT_ACCOUNT=senzing -export GIT_REPOSITORY=github-action-install-senzing +export GIT_ACCOUNT=senzing-factory +export GIT_REPOSITORY=github-action-install-senzing-api ``` Synthesize environment variables. @@ -116,9 +113,22 @@ TODO: ### Pull Requests Code in the main branch is modified via GitHub pull request. -Follow GitHub's -[Creating a pull request from a branch](https://help.github.com/articles/creating-a-pull-request/) -or -[Creating a pull request from a fork](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) instructions. +Follow GitHub's [Creating a pull request from a branch] or +[Creating a pull request from a fork] instructions. Accepting pull requests will be at the discretion of Senzing, Inc. and the repository owner(s). + +[already been reported]: https://github.com/search?q=+is%3Aissue+user%3Asenzing +[Asking questions]: #questions +[Code of Conduct]: CODE_OF_CONDUCT.md +[Contributing code or documentation]: #contributing-code-or-documentation +[Corporate Contributor License Agreement (CCLA)]: .github/senzing-corporate-contributor-license-agreement.pdf +[Creating a pull request from a branch]: https://help.github.com/articles/creating-a-pull-request/ +[Creating a pull request from a fork]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/ +[GitHub issue]: https://help.github.com/articles/creating-an-issue/ +[Individual Contributor License Agreement (ICLA)]: .github/senzing-individual-contributor-license-agreement.pdf +[LICENSE]: LICENSE +[License Agreements]: #license-agreements +[Pull Request]: #pull-requests +[Reporting bugs]: #bug-reporting +[Requesting features]: #feature-requests diff --git a/action.yaml b/action.yaml index 4d0c7af..daaa8fb 100644 --- a/action.yaml +++ b/action.yaml @@ -12,19 +12,19 @@ runs: steps: - if: runner.os == 'Linux' name: Run on Linux - uses: senzing-factory/github-action-install-senzing-api/linux@69-skern + uses: senzing-factory/github-action-install-senzing-api/linux@v3 with: senzingapi-runtime-version: ${{ inputs.senzingapi-runtime-version }} - if: runner.os == 'macOS' name: Run on macOS - uses: senzing-factory/github-action-install-senzing-api/darwin@69-skern + uses: senzing-factory/github-action-install-senzing-api/darwin@v3 with: senzingapi-version: ${{ inputs.senzingapi-version }} - if: runner.os == 'Windows' name: Run on Windows - uses: senzing-factory/github-action-install-senzing-api/windows@69-skern + uses: senzing-factory/github-action-install-senzing-api/windows@v3 with: senzingapi-version: ${{ inputs.senzingapi-version }}