Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 2.14 KB
Raw

Contributing

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

  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!

Running development version locally

To run a development version of Conjur Inspect, start the development environment with:

$ cd dev
$ ./start
...
[root@a0a4483ca6c9 conjur-inspect]#

This starts a development container and begins a terminal within. Then run the CLI from source with the command:

make run

Building the Conjur Inspect CLI

To build the CLI and its release artifacts, run the command:

bin/build-release

When this command finishes, the CLI binary and installers are available under the 'dist/` directory.

Running unit tests

Run the Conjur Inspect unit tests with the command:

bin/test-unit

Alternatively, within the dev/ containerized development environment, the unit tests may be run with the command:

make test

Running integration tests

To run a set of integration tests that exercise conjur-inspect in a couple of representative environments, use the command:

bin/test-integration

Releasing

To create a new release, follow the instructions in our general release guidelines here.