Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.7 KB
Raw

Contributing guidelines

Thank you for your interest in contributing! Any contribution is highly appreciated ✨

Preparing a Pull Request

A good PR is small, focuses on a single feature or improvement, and clearly communicates the problem it solves. Try not to include more than one issue in a single PR. It's much easier to review multiple small pull requests than one that is large.

  1. Fork the repository.

  2. Clone the fork to your local machine and add upstream remote:

git clone https://github.com/<your username>/geist.git
cd geist
git remote add upstream https://github.com/shyakadavis/geist.git
  1. Synchronize your local main branch with the upstream remote:
git checkout main
git pull upstream main
  1. Install dependencies with PNPM:
pnpm i
  1. Create a new branch related to your PR:
git checkout -b fix/bug-being-fixed
  1. Make changes, then commit and push to your forked repository:
git push -u origin HEAD
  1. Go to the repository and make a Pull Request.

Notes

Coming from shadcn-svelte, theming is different here in order to keep the APIs as close to the original as possible.

For example, class names like bg-accent, text-muted-foreground, etc. produce no output. (Tailwind CSS IntelliSense will help you with catching these ghost class names.)

As such, please refer to the src/app.css file for the actual styles that are being applied.