From a8494ee4380cdfb38a90eafab751b6725806f79f Mon Sep 17 00:00:00 2001 From: Ingrid Crant Date: Wed, 3 Apr 2024 12:11:53 -0400 Subject: [PATCH] contributing.md changes --- CONTRIBUTING.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 855241d..5985503 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,21 +3,22 @@ Thank you for your interest in contributing to the 1Password load-secrets-action project 👋! Before you start, please take a moment to read through this guide to understand our contribution process. ## Testing +Unit tests can be run with `npm run test`. After following the steps below for signing commits, you can test against your PR with these steps: -1. Create or use an existing repo to run the `load-secrets` GitHub Action +1. Create or use an existing repo to run the `load-secrets` GitHub Action. 2. In a workflow yaml file that uses the GitHub Action, modify the `uses: 1Password/load-secrets-action` line to be - ``` - uses: 1Password/load-secrets-action@ + ```yaml + uses: 1Password/load-secrets-action@ + ``` + OR + ```yaml + uses: 1Password/load-secrets-action@ + ``` - # OR - - uses: 1Password/load-secrets-action@ - ``` - -3. Trigger the action, which now includes your changes +3. Trigger the action, which now includes your changes. ## Documentation Updates