Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

87 lines (65 loc) · 2.76 KB
Raw

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

Ensure that you have the following tools installed on your machine:

  • Java development kit (JDK) 17
  • IntelliJ IDEA Ultimate Edition
  • git-cliff (maintainers only)
  1. Fork the repository and clone it to your local machine. 
    gh repo fork biomejs/biome-intellij --clone

Development

The plugin can be started in IDEA by running the runIde Gradle task. This will start a new instance of IDEA with the plugin loaded.

./gradlew runIde

Running tests

To run the plugin's tests, run the test Gradle task.

./gradlew runIdeForUiTests &
./gradlew test

Making changes

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

    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.

Maintainers

This section is for maintainers only. It describes the process for releasing a new version of the extension.

Releasing a stable version

  1. Create a new branch for the release. 
    git fetch
git checkout -b release/vX.Y.Z main
  2. Generate the changelog. 
    git-cliff --bump e71479100d4ed81b3e9c26881c38a0ddb7da31eb..
  3. Bump the version in gradle.properties and to match the latest version in the changelog.
  4. Commit and push your changes.
  5. Create a pull request named chore(release): prepare vX.Y.Z.
  6. Merge the pull request.
  7. Run the Publish workflow manually from the Actions tab in GitHub (uncheck nightly).

Releasing a nightly version

  1. Commit your changes to the main branch.
  2. Generate the changelog. 
    git-cliff e71479100d4ed81b3e9c26881c38a0ddb7da31eb..
  3. Commit and push your changes.
  4. Run the Publish workflow manually from the Actions tab in GitHub (check nightly).