Skip to content

Commit

Permalink
chore: add contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nhedger committed Nov 8, 2023
1 parent 17931e9 commit 54a562a
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

Thank you for your interest in contributing to this project!

Please review the following guidelines before making your contribution.

> [!IMPORTANT]
> If you plan on making a significant contribution, we recommend that you first create a discussion describing your proposed contribution to the project. This allows the project maintainers to provide early feedback that can help guide your contribution.
## Project setup

1. Fork the repository and clone it to your local machine.
```shell
gh repo fork biomejs/biome-vscode --clone
```
2. Install the dependencies.
```shell
pnpm install
```

## Development

The extension can be started in debug mode by pressing <kbd>F5</kbd> in Visual Studio Code. This will start a watcher that automatically rebuilds the extension when you make changes and opens a new VS Code window with only the Biome extensione extension loaded.

## Making changes

1. **Create a branch.** Before making any changes, create a branch to work on.
```shell
git checkout -b my-branch-name
```
2. **Make your changes.** Make your changes to the codebase and commit them. The format of your commit messages is not important at this stage because they will be squashed later, but please ensure that your commit messages are descriptive.

3. **Create a pull request.** Once you are done making your changes, push your branch to your fork and create a pull request. Please ensure that the title of your pull request follows the conventional commits specification.

0 comments on commit 54a562a

Please sign in to comment.