Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (66 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

100 lines (66 loc) · 3.02 KB

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Reporting Bugs

The best way to report a bug is to open an issue on GitHub. Please include as much information as possible, including:

  • A clear description of the problem
  • Steps to reproduce the problem
  • The expected behavior
  • The actual behavior

This will help us understand the issue and fix it more quickly.

Suggesting Enhancements

If you have an idea for a new feature or enhancement, please open an issue on GitHub.

Submitting Changes

  1. Fork and clone the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Write tests for your changes (if applicable)
  5. Run the tests to make sure everything is working
  6. Commit your changes with a clear commit message
  7. Push your changes to your fork
  8. Open a pull request against the main branch of the original repository

Required Tools

  • Rust
  • Cargo
  • CodeQL (optional as the action will download it for you)
    • gh-codeql is a great tool to help you with CodeQL CLI.

Local Setup

Environment Variables

To run the action locally, you need to set up the following environment variables:

# DEBUG=1
GITHUB_REPOSITORY=advanced-security/codeql-extractor-action

INPUT_EXTRACTORS=advanced-security/codeql-extractor-iac@v0.5.0
INPUT_PACKS=advanced-security/iac-queries@0.5.0
INPUT_LANGUAGES=iac

These are the inputs to the action. You can modify them as needed.

Building the Project

To build the project, use the following command:

cargo build --release

And to install it on the system, use:

cargo install --path .

This means it can be run from anywhere using the command codeql-extractor-action.

Running Tests

To run the tests, use the following command:

cargo test

Running Linter

To run the linter, use the following command:

cargo clippy

Resources