Skip to content

Latest commit

 

History

History
138 lines (97 loc) · 4.78 KB

CONTRIBUTING.md

File metadata and controls

138 lines (97 loc) · 4.78 KB
Raw

Contributing

It looks like you're interested in contributing to vite-plugin-entry-shaking, thank you so much! Whether you are a novice or experienced contributor, this guide should help you going through the whole process of submitting contributions.

Note If you're a novice contributor, Github's How to Contribute to Open Source might be a really valuable resource to get you started with the Open Source world's customs and philosophy.

If you've already read through this guide and still have questions on how to to contribute, feel free to create a new discussion.

Table of contents

  1. Pre-requesites
  2. Forking the repository
  3. Installing dependencies
  4. Start developing
  5. Checking your work
  6. Adding a changeset
  7. Submitting a pull request

Pre-requisites

This project is written in TypeScript and uses Node.js as a JavaScript runtime and pnpm as a package manager. Please make sure those are installed and that their versions match the ones specified in the engines field of the root package.json file.

You can check both versions by running the following commands in a terminal:

node -v
pnpm -v

This project also uses:

It is recommended (but optional) to plug these tools into your IDE by using their respective extensions. This should considerably improve your developer experience. If you're using Visual Studio Code, you should be prompted to install any missing recommended extension when opening the project's workspace.

Forking the repository

To start contributing to the project, first fork the repository, then clone your by running either of the following commands:

# Using HTTPS
git clone https://github.com/your-username/vite-plugin-entry-shaking.git

# Using SSH
git clone git@github.com:your-username/vite-plugin-entry-shaking.git

Installing dependencies

Install the project's dependencies by running the following command within the project root directory:

pnpm i

Once the dependencies are installed, pnpm may run postinstall scripts to setup the project.

Start developing

Create a new branch for your contribution by running the following command:

git checkout -b my-branch-name

You can then start developing by running the following command from the packages/core folder:

pnpm dev

This will start unbuild's passive watcher so that you can test your changes without having to actually rebuild anything. When the passive watcher is launched, you can test your changes against on of the provided examples.

The "Resources" document also may help you understand how the plugin works under the hood and provide a bit of guidance when working with this repo's codebase.

Checking your work

Once you feel confident with your change and ready to share your contribution, please make sure you run the following command from the project root:

pnpm check

This should trigger a series of actions that you may also launch manually:

  1. Running prettier to format code: pnpm format
  2. Running ESLint to lint code: pnpm lint
  3. Running tests through Vitest: pnpm test

Adding a changeset

This project uses Changesets to manage versioning and changelogs. If your contribution affects the codebase and requires bumping versions of any package, you should add a changeset describing your changes by running the following command:

pnpm changeset

Please follow this guide if you need help with generating a changeset.

Note Some contributions (e.g. fixing a typo in a README) do not need changesets.

Submitting a pull request

When you're ready to submit a pull request, you may follow these naming conventions:

  • Imperative Mood for pull request titles (e.g., Add something, Fix something).
  • Past tense verbs for changesets (e.g., Added something, Fixed something).