Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 1.45 KB
Raw

Contribute to nextlint

Start by forking the project's repository on GitHub. This creates a copy of the project under your GitHub account, allowing you to make changes without directly affecting the original project.

Setup environment:

We recommend installing Node.js using Volta(JavaScript Tool Manager) and pnpm for managing dependencies.

Install Volta and node:

# install Volta
curl https://get.volta.sh | bash

# install Node
volta install node

Install pnpm:

volta install pnpm

Fork and clone nextlint repository

git clone [email protected]:{your-username}/nextlint.git

Change working directory to nextlint:

// 1. install dependencies
pnpm install
// 2.1 start in development mode
pnpm dev
// 2.2 playground with editor
pnpm run --filter=svelte playground

Create a Pull Request

Nextlint using changeset to release and manage versions, more detail about versioning with changeset

Here are steps to create a pull request with a changeset release:

  1. Create feature/fix branch:
git branch -b feat/bubble_menu
  1. Commit your change
git add .
git commit -m "feat(bubble_menu): fix style...."
  1. Create a changeset if you want to publish a version of this change:
pnpm changeset
  1. Push Code and create PR into nextlint