Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

112 lines (76 loc) · 4.05 KB
Raw

Contributing

First off, thank you for taking the time and effort to contribute! It means a lot to me :3
Make sure to read this whole page, I promise you it's not a mouthful TikTok emote of a pink face sticking out its tongue, [funnyface]

Building locally

Prerequisites

  • NodeJS (LTS) >= v20
  • pnpm >= v9
    • Any other node package manager can be used, but you'll have to modify the scripts in package.json
  • git

Steps

Start by cloning the repository:

git clone https://github.com/nexpid/BunnyPlugins.git --branch dev

Caution

Make sure your changes are made to the dev branch, not the main branch.

Then, install dependencies, build plugins and run the server.

pnpm i
pnpm dev
pnpm serve # ps: you should open another terminal tab for this

Tip

Building plugins in dev mode (pnpm build --dev) won't minify their dist syntax to make plugins easier to debug.

Finally, make sure your phone and your computer are connected to the same network, and look for the correct IP address.
You can now install whatever plugin you want using that IP at port :8731, e.g., http://192.168.2.22:8731/cloud-sync

Live refetch

If you want to go a step further, you can live refetch plugins with the rejuvenate plugin.
Start by running the same code snippet as above, but using the watch script instead of dev:

pnpm watch # doesn't build every plugin on startup!
pnpm serve # ps: you should open another terminal tab for this

Then, install the rejuvenate.dev1 plugin, and you're done! Your plugins now automatically refresh when you edit any file.

Testing github workflows

Prerequisites

Steps

Start by cloning the repository:

git clone https://github.com/nexpid/BunnyPlugins.git --branch dev

Caution

Make sure your changes are made to the dev branch, not the main branch.

Then, copy and paste .actrc.sample to .actrc and replace with the output of gh auth token:

cp .actrc.sample .actrc
sed -i s/<TOKEN HERE>/$(gh auth token)/g" ".actrc"

Finally, make your changes, test them with act and you're done!

act -W ".github/workflows/<workflow>.yml"

Commiting your changes

Before you start committing your changes, you need to make sure your workspace is set up correctly. For starters, make sure you're on a seperate feature branch, which should be titled feat/<summary of your changes>:

git remote add upstream https://github.com/nexpid/BunnyPlugins.git # add the upstream remote
git fetch upstream # fetch all of its branches
git checkout -b feat/......... upstream/dev # switch to a new branch based on upstream/dev

Then, make sure to split them up into multiple commits for better readability.
While not required, it's recommended to title your commits based on this modified version of semantic commit messages I use:

  • feat — any general changes to the codebase (e.g., adding a feature to a plugin)
  • fix — a commit specifically fixing some part of the code (e.g., fixing a bug in a plugin)
  • refactor — refactoring a big portion of the codebase (e.g., reworking a plugin)
  • chore — some automated task (e.g., running a linter)
  • docs — changes to markdown files, like this one (e.g., fixing a tpyo in CONTRIBUTING.md)

Once you're done, push your changes to origin, and create a PR!

git push origin feat/......... # ps: as of august 2024, vs code source control doesn't let you push to a different remote, you must do this using git

Happy contributing!!

Footnotes

  1. Plugins marked as "dev only" (plugin path ending with .dev) will only be built in watch mode (pnpm watch) or a dev build (pnpm dev) ↩