If you are having problems using this SDK or have a question about the Annotator for Clinical Data service, refer here:
If you encounter an issue with the project, you are welcome to submit a bug report.
Commit messages should follow the Angular Commit Message Guidelines. This is because our release tool - semantic-release - uses this format for determining release versions and generating changelogs. Tools such as commitizen or commitlint can be used to help contributors and enforce commit messages. Here are some hypothetical examples of acceptable commit messages, along with the release type that would be done based on the commit message:
| Commit message | Release type |
|---|---|
fix(cartridges): fix get cartridges missing field JSON response |
|
feat(insight models): add support for clinical insights normality model |
|
feat(user data): remove deleteUserSpecificArtifacts optionBREAKING CHANGE: Support for deleteUserSpecificArtifacts method has been removed. |
(Note that the BREAKING CHANGE: token must be in the footer of the commit) |
If you want to contribute to the repository, here's a quick guide:
- Fork the repository
- Develop and test your code changes:
- To build/test:
mvn clean package - Please add one or more tests to validate your changes.
- To build/test:
- Make sure everything builds/tests cleanly
- Commit your changes
- Push to your fork and submit a pull request to the master branch
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.