Skip to content

Latest commit

 

History

History
124 lines (78 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

124 lines (78 loc) · 2.36 KB
Raw

Contributing

Thank you for your interest in contributing!

The below document describes how to build and test the project and submit your contributions.

Getting Started

The basic commands to get the repository cloned and built locally follow:

$ git clone https://github.com/wulfmann/auto-cdk.git
$ cd auto-cdk
$ yarn install
$ yarn build

Linking

Since a lot of the functionality depends on the filesystem structure, it's usually easier to link the projectlocally so that you can iterate while using it in a spearate place.

You can do this by running:

$ yarn link

Now you can create a separate node project somewhere else by running the following in a new directory and following the prompts:

$ yarn init
$ yarn add auto-cdk
$ yarn link auto-cdk

Now changes you make to auto-cdk will reflect in the new project. It is recommended that you run auto-cdk in watch mode while developing.

To unlink later you can run:

$ yarn unlink auto-cdk

Watching

You can enable live-compiling by running:

$ yarn watch

Pull Requests

Open Issue

Add your Changss

Tests

Commit

Pull Request

Merge

Tools

This section describes some of the tools this project uses for building, testing and maintaining code quality.

Linting

This project uses TSLint for code linting.

To check if any files have bad formatting run:

$ yarn lint

To auto-fix linting issues (ones that can anyways) run:

$ yarn lint --fix

Formatting

This project uses Prettier for code formatting.

To check if any files have bad formatting run:

$ yarn format --check

To allow the formatter to modify files run:

$ yarn format --write

Testing

This project uses Jest for testing.

To run the tests, run the following:

$ yarn test

Troubleshooting

Ensure that you can reproduce your issue after doing a complete rebuild:

$ git clean -fqdx .
$ yarn build