CONTRIBUTING.md

Contributing

Table of Contents

• Guidelines
• Getting started
  • Prerequisites
  • Installation
• Building
• Testing

Guidelines

See GUIDELINES.md for more information.

Getting started

Prerequisites

1. Install act

Installation

1. Clone the repository:

git clone https://github.com/MrSquaare/ssh-setup-action.git

2. Install dependencies:

npm install

Building

Build the project:

npm run build

Testing

Lint the code:

npm run lint

Format the code:

npm run format

Run workflows with act:

act pull_request

Note: You will need to adapt the existing workflows