Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (16 loc) · 947 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 947 Bytes
Raw

Contributing

We love pull requests. Here's a quick guide.

Please refer to the README.md for information about the structure of this repo (note that this repo supports our packages datadog-cdk-constructs and datadog-cdk-constructs-v2)

  1. Fork, clone and branch off main: 
    git clone [email protected]:<your-username>/datadog-cdk-constructs.git
git checkout -b <my-branch>
  2. Install dependencies with yarn install.
  3. Make your changes.
  4. Run unit tests with yarn test.
  5. Manually test your changes using CDK commands such as cdk synth, cdk diff, and cdk deploy.
    • Please see the README.md for instructions on how to manually test.
  6. Push to your fork and submit a pull request.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.