Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.28 KB
Raw

Contributing

[Are you accepting contributions at this time? If not, please state that here. No need to include content from the rest of this document.]

For general contribution and community guidelines, please see the community repo.

Table of Contents

Development

TODO: [What development tools are required to start working on this project?]

Testing

  1. Go into SpringBootExample folder and set up sample client application for connecting to Conjur via Spring-boot-sdk

    $ cd SpringBootExample

  2. Create Docker image for sample client application.

    $ ./build-sampleapp-image.sh

  3. Set up Sample client app and Conjur OSS environment as docker containers to test Spring-boot-sdk.

    $ ./start

    once start script finishes

     It creates a container out of sample application.
 It sets up conjur OSS environment as containers.
 Logs into Conjur OSS environment  and adds secrets to secrets vault.
 Finally run sample client app, client app connects to Conjur OSS via Spring-boot-sdk and fetches required secrets from Conjur OSS.

  4. Clean Up.

    $ ./stop

    Running stop removes the running Docker Compose containers of Sample app and Conjur OSS environment.

Releases

TODO: [Instructions for creating a new release]

Contributing workflow

  1. Fork the project
  2. Clone your fork
  3. Make local changes to your fork by editing files
  4. Commit your changes
  5. Push your local changes to the remote server
  6. Create new Pull Request

From here your pull request will be reviewed and once you've responded to all feedback it will be merged into the project. Congratulations, you're a contributor!