Skip to content

Commit

Permalink
feat: Rebrand ACD SDK
Browse files Browse the repository at this point in the history
BREAKING CHANGE: Packaging name change to acd_sdk
  • Loading branch information
dlangst committed Mar 24, 2023
1 parent e5ca137 commit 17d0e58
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you are having problems using the SDK or have a question about the Annotator
refer here:
* [README](README.md)
* [Annotator for Clinical Data documentation](https://merative.github.io/acd-containers/)
* [Annotator for Clinical Data product site](https://www.ibm.com/cloud/watson-annotator-for-clinical-data)
* [Annotator for Clinical Data Support page](https://merative.github.io/acd-containers/support/support/)

# Issues

Expand Down Expand Up @@ -62,8 +62,9 @@ Here are some examples of acceptable commit messages, along with the release typ

| Commit message | Release type |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| `fix(<optional scope>): <fix message details>` | Patch Release |
| `fix(<optional scope>): <fix message details>` | ~~Patch~~ Fix Release |
| `feat(<optional scope>): <feature message details>` | ~~Minor~~ Feature Release |
| `feat(<optional scope>): <feature message details>`<br><br>`BREAKING CHANGE: <message details>` | ~~Major~~ Breaking Release <br/> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |

## Pull requests

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pip install --upgrade acd-sdk

## Migrating from version 1.x.x

The 2.0 release of the Annotator for Clinical Data SDK introduces a Python package name change from `ibm_whcs_sdk` to 'acd_sdk`. For the migration from 1.x.x:
The 2.0 release of the Annotator for Clinical Data SDK introduces a Python package name change from `ibm_whcs_sdk` to `acd_sdk`. For the migration from 1.x.x:

1. After running `pip install --upgrade acd-sdk`, confirm that you have version 2.0 installed by running `pip show acd-sdk`.
2. In your application files that have a dependency on `acd-sdk`, update any import declarations from `ibm_whcs_sdk` to `acd_sdk`.
Expand All @@ -37,8 +37,8 @@ For general SDK usage information, please see [this link](https://github.com/IBM
## Questions

For questions, refer to:
* [Annotator for Clinical Data product site](https://www.ibm.com/cloud/watson-annotator-for-clinical-data)
* [Annotator for Clinical Data documentation](https://merative.github.io/acd-containers/)
* [Annotator for Clinical Data Support page](https://merative.github.io/acd-containers/support/support/)

## Issues
If you encounter an issue with the project, you are welcome to submit a
Expand Down

0 comments on commit 17d0e58

Please sign in to comment.