Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (45 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 1.58 KB

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.
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:
git clone https://github.com/YOUR-USERNAME/swark.git
cd swark
  1. Install dependencies:
npm install
  1. Create a new branch:
git checkout -b feature-name

  1. Make your changes

  2. Test the extension in VS Code using F5

  3. Run tests:

npm test
  1. Push the new branch and proceed to submit a pull request:
git push

Submitting Pull Request

  1. Update the README.md with details of changes if needed (e.g. new extension setting)
  2. Update the CHANGELOG.md following Keep a Changelog
  3. Create the pull request

Requesting Features

Create a new issue and label it with enhancement.

Reporting Bugs

Create a new issue 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.