Review the following guidelines for submitting questions, issues, or changes to this repository.
This SDK follows coding style based on Coding conventions for source code in the Kotlin Programming Language.
If you encounter an issue, have a question or want to suggest an enhancement to the IBM Security Verify SDK, you are welcome to submit a request. Before that, please search for similar issues. It's possible somebody has encountered this issue already.
If you want to contribute to the repository, here's a quick guide:
- Fork the repository
- Develop and test your code changes:
- Follow the coding style as documented above
- Please add one or more tests to validate your changes.
- Make sure everything builds/tests cleanly.
- Commit your changes
- Push to your fork and submit a pull request to the
mainbranch
To generate the HTML docs, run ./gradlew <component>:dokkaJavadoc in the project's root directory. Then view the docs in the ./RelyingPartySdk/build/dokka/html directory:
open index.html
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.