Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.24 KB

Contributing In General

Our project welcomes external contributions. If you have an itch, please feel free to scratch it.

To contribute code or documentation, please submit a pull request.

Proposing new features

If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.

Fixing bugs

If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.

Merge approval

The project maintainers use the GitHub reviewer functionality to indicate acceptance or to request changes.

For a list of the maintainers, see the MAINTAINERS.md page.

Setup

  1. git clone git@github.com:IBM/audit-ci.git
  2. cd audit-ci
  3. npm install

Testing

Mocha + Chai testing is performed in the test directory. Most tests are end-to-end tests. In the case for audit-ci, when calling audit-ci, compare the expected output with the actual output.