Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.39 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to this project! Please review the following guidelines before making your contribution.

Important

If you are considering making significant alterations to the project, we suggest initiating a discussion to confirm that your proposed changes align with the project's objectives. Doing so can help you save both time and effort.

Project setup

  1. Fork and clone the repo. You will need to fork the repo and clone it locally to your machine. If you already have the GitHub CLI installed, you can run the following command.

    gh repo fork biomejs/setup-biome --clone

  2. Install the dependencies. We use Bun to manage the dependencies. The installation process will also setup git hooks to ensure that your commits are formatted correctly. To install the dependencies, run the following command.

    bun install

Making changes

  1. Create a branch. Before making any changes, create a branch to work on.

    git checkout -b <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. Git hooks will ensure that your commits are formatted correctly.

  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.

Maintainers

This section is intended for maintainers of this project.

Releasing a new version

  1. Make sure you're on the main branch that it's up to date with the remote.
  2. Run bun tag vX.Y.Z to tag the current commit with the version number. This will automatically create the corresponding "short tags" (e.g. v1, v1.0, v1.0.0) and make them point to the same commit.
  3. Run git push --tags --force to push the tags to the remote.
  4. Create a new release on GitHub, and choose the full-version tag (e.g. v1.0.0) as the target.