# Contributing to Swark

Thank you for your interest in contributing to Swark!  
Swark welcomes contributions. There are multiple ways to contribute:

1. Submit pull requests for open issues.
2. Report bugs.
3. Request new features.

## Code Contribution

You are welcome to submit pull requests for [open issues](https://github.com/swark-io/swark/issues).  
Issues that have been reviewed and are **ready to accept PRs** are labeled as `planned`.  
Issues that are labeled as `backlog` are currently not planned and will be considered in the future.

### Development Setup

1. Fork and clone the repository:

```bash
git clone https://github.com/YOUR-USERNAME/swark.git
cd swark
```

2. Install dependencies:

```bash
npm install
```

3. Create a new branch:

```bash
git checkout -b feature-name
```

4. Make your changes

5. Test the extension in VS Code using `F5`

6. Run tests:

```bash
npm test
```

7. Push the new branch and proceed to submit a pull request:

```bash
git push
```

### Submitting Pull Request

1. Update the [README.md](README.md) with details of changes if needed (e.g. new extension setting)
2. Update the [CHANGELOG.md](CHANGELOG.md) following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
3. Create the pull request

## Requesting Features

Create a [new issue](https://github.com/swark-io/swark/issues/new) and label it with `enhancement`.

## Reporting Bugs

Create a [new issue](https://github.com/swark-io/swark/issues/new) and label it with `bug`.  
Alternatively, you can report the bug via email: contact@swark.io

## Questions?

Feel free to email us at contact@swark.io.