CONTRIBUTING.md

Contributing

This document describes how to set up a development environment and submit your changes.

Getting Started

Setup

Required

• Rust
• Git
• GitHub account

Recommended

• Brew
• IDE
  • VSCode
  • IntelliJ
• GitHub CLI

// Using github cli
gh repo fork cdklabs/cdk-from-cfn
cd cdk-from-cfn
cargo build

Tests

cargo test

./tasks/coverage.sh

Making changes

Following guidance is for making changes in your fork and pushing changes to your fork's remote:

git status
git add <file-name or .>
git commit -m "<commit message following https://www.conventionalcommits.org/en/v1.0.0/#summary>"
git push

Once you have done the above, you can then create a PR from your fork.