From 5c978a204ee9cc2ae21cdbc5b758f1b27d8562e9 Mon Sep 17 00:00:00 2001 From: Tom Birdsong Date: Mon, 9 Jan 2023 10:39:18 -0500 Subject: [PATCH] WIP: Fixup 2 for !51 --- docs/CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a953e84..9d450e0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -90,7 +90,7 @@ to get started. You will need to: Workflows will need to be maintained and updated over time as tools and technology progress. The best approach to modifying a workflow -is to try to recreate steps on your local system (if possible), +is to recreate steps on your local system (if possible), identify failures and fixes, then translate fixes to the reusable workflow in question. If you encounter an issue that requires community input you can ask for help on the @@ -126,7 +126,7 @@ $ git commit $ git push ``` -1. Fork the [ITKSplitComponents repository](https://github.com/InsightSoftwareConsortium/ITKSplitComponents) +2. Fork the [ITKSplitComponents repository](https://github.com/InsightSoftwareConsortium/ITKSplitComponents) to your GitHub user account and clone to your local machine: ```sh $ cd .. @@ -134,12 +134,12 @@ $ git clone git@github.com:/ITKSplitComponents.git $ cd ITKSplitComponents ``` -1. Create a development branch for your proposed changes: +3. Create a development branch for your proposed changes: ```sh $ git checkout -b "my-cool-feature" ``` -1. Update the external module workflow `.yml` file to reference your changes. Either the name of the +4. Update the external module workflow `.yml` file to reference your changes. Either the name of the development branch or the desired development commit hash may be used to reference workflows. ```yml name: Build, test, package @@ -158,16 +158,16 @@ jobs: pypi_password: ${{ secrets.pypi_password }} ``` -1. Commit and push your changes: +5. Commit and push your changes: ```sh $ git commit $ git push ``` -1. Visit `https://github.com//ITKSplitComponents/actions` to view running Github Actions jobs. +6. Visit `https://github.com//ITKSplitComponents/actions` to view running Github Actions jobs. Other ITK external modules may also be used for testing: -- [ITKBSplineGradient](https://github.com/insightSoftwareConsortium/ITKbsplinegradient) can be +- [ITKBSplineGradient](https://github.com/InsightSoftwareConsortium/ITKBSplineGradient) can be used for building with a dependency on one other ITK external module; - [ITKUltrasound](https://github.com/KitwareMedical/ITKUltrasound) can be used for building with dependencies on multiple ITK external modules.