# Contributing to Obsidian Code Styler

Thanks for taking the time to contribute!

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

---

## Table of Contents

- [Setting Up the project locally](#setting-up-the-project-locally)
- [Submitting a Pull Request](#submitting-a-pull-request)

## Setting Up the project locally

See the steps outlined in the [Unofficial Developer Documentation](https://marcus.se.net/obsidian-plugin-docs/getting-started/create-your-first-plugin#step-2--build-the-plugin) for building a plugin and the format of plugins as outlined in the [sample plugin](https://github.com/obsidianmd/obsidian-sample-plugin).
Using an IDE such as [VSCode](https://code.visualstudio.com/) as it helps ensure that variable typing is respected.

## Submitting a Pull Request

Please go through existing [issues](/../../../issues) and [pull requests](/../../../pulls) to check if somebody else is already working on it.
Make sure that the [README](/README.md) and [CHANGELOG](/CHANGELOG.md) are updated appropriately using [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!--
Also, make sure to run the tests and lint the code before you commit your changes.

```sh
npm run test
npm run lint
```
-->