Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.74 KB

Contributing

This doc describes getting set up to work with git to contribute to this project.

Table of Contents generated with DocToc

Install Pre-Commit

  • Make sure you have an SSH key and optionally a GPG key added to your GHE profile.
  • Optionally, configure git to use your GPG key for commit signing.

Set up your local repository:

  1. clone this repo to your system

    git clone [email protected]:keegoid-nr/cloudscript.git

  2. install pre-commit

    brew install pre-commit
pre-commit -V

  3. From inside the repo, update repos defined in .pre-commit-config.yaml to latest tags and install the pre-commit git hook:

    cd cloudscript
pre-commit autoupdate
pre-commit install -t pre-commit -t pre-push -t prepare-commit-msg

    If you encounter any trouble with pre-commit, it is easy to uninstall.

    pre-commit uninstall -t pre-commit -t pre-push -t prepare-commit-msg

Check for keys

Before committing changes, check for any customer api, license, or private location keys that may have made their way into your changes from logs or other info the customer sent. If you find any, replace them with [REDACTED].