If you've found a bug in gill that you'd like to fix, please open an issue before working on specific code changes to ensure it is within scope and desire for this library. Once approved, submit a pull request with your changes. Include a helpful description of the problem and how your changes address it, and provide tests so we can verify the fix works as expected.
If there's a new feature you'd like to see added to gill, please open an issue before working on specific code changes to ensure it is within scope and desire for this library.
Contributions are welcome and loved, but it's best to discuss major changes before investing time in implementation.
Before getting started, ensure your system has access to the following tools:
Clone and prepare the repo locally:
git clone https://github.com/gillsdk/gill.git
cd gill
pnpm install
Build all the packages in parallel (via Turborepo):
pnpm build
Note: You must run the build command the first time manually before running the test commands detailed below.
To build a specific package, use the --filter flag:
pnpm build --filter=gill
pnpm build --filter=@gillsdk/react
# or multiple specific packages
pnpm build --filter=gill --filter=@gillsdk/react
All unit tests can be run at the same time (including rebuilding):
pnpm test
Note: You must run the build command the first time manually before running the
testcommand.
Please ensure that all tests are passing when submitting a pull request. If you're adding new features to the gill sdk, always include tests.
When submitting a pull request:
When a pull request is created, gill maintainers will be notified automatically.