Skip to content

Commit

Permalink
WIP: Fixup 2 for !51
Browse files Browse the repository at this point in the history
  • Loading branch information
tbirdso committed Jan 9, 2023
1 parent 860ef16 commit 5c978a2
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -126,20 +126,20 @@ $ 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 ..
$ git clone [email protected]:<your-username>/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
Expand All @@ -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/<your-username>/ITKSplitComponents/actions` to view running Github Actions jobs.
6. Visit `https://github.com/<your-username>/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.
Expand Down

0 comments on commit 5c978a2

Please sign in to comment.