Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 1.59 KB
Raw

Contributing

Thanks for your interest in contributing to Gitleaks-Action!

Quickstart

  • Make changes to the files in the src directory.
  • "Build" the dist using ncc:
    • Use nvm to select the right version of node:
    nvm use
    • Install dependencies:
    npm i
    • Run the build command:
    npx ncc build src/index.js
  • You can use act to test Gitleaks-Action on your local machine.
    • More info to come on this later
    • We hope to create a script that runs a test suite locally using act at some point.

Legal

The source code for Gitleaks-Action is made available under our commercial license, and the copyright is owned by Gitleaks LLC.

By submitting a Pull Request, you disavow any rights or claims to any changes submitted to this project and assign the copyright of those changes to Gitleaks LLC.

If you cannot or do not want to reassign those rights (your employment contract for your employer may not allow this), you should not submit a PR. However, you can open an issue and someone else can do the work.

This is a legal way of saying "If you submit a PR to us, that code becomes ours". 99.9% of the time that's what you intend anyways; we hope it doesn't scare you away from contributing.

Credit to the Sidekiq contribution guidelines for the concepts and most of the language above.