Rzl Zone logo
Rzl Zone
Build ToolsContributing

Contributing

Learn how to contribute to Build Tools — including local setup, code style conventions, and the pull request process.

About Contributing

Hello there! 🎉
We’re excited that you want to contribute to @rzl-zone/build-tools. 🙌
This guide will help you set things up so you can start improving the build output system and overall developer experience.

How You Can Contribute?

We welcome all types of contributions, including:

  • Fixing build output inconsistencies.
  • Improving export handling or structure.
  • Documentation improvements.
  • Refactors or performance improvements.

No contribution is too small — every PR helps make the project better!

Getting started

This package is part of a monorepo.
All contributions are made through the main repository.

Follow these steps to set up your local development environment:

Fork the repository

Click the Fork button on the main repository:
https://github.com/rzl-zone/rzl-zone
This creates your own copy of the project under your GitHub account.

Clone your fork

terminal
# Clone your fork of the monorepo
git clone https://github.com/[YOUR-USERNAME]/rzl-zone.git

# Navigate into the repository
cd rzl-zone

# Navigate to the build-tools package
cd packages/build-tools

Install dependencies

terminal
pnpm install

Create a new branch

It’s best practice to work on a dedicated feature branch instead of the main branch.

terminal
git checkout -b feature/my-awesome-feature

Make your changes, add tests script
Make your updates related to build output handling, then run the test suite and build the package:

terminal
npx vitest run
pnpm --filter @rzl-zone/build-tools build

Commit your changes
Use clear and descriptive commit messages that follow the conventional commit style:

terminal
git add .
git commit -m "feat(build-tools): improve output structure"

Push to your fork

terminal
git push origin feature/my-awesome-feature

Create a Pull Request (PR)
Go to your fork on GitHub, click Compare & pull request, and submit your PR to:
https://github.com/rzl-zone/rzl-zone
Please ensure your branch is up-to-date with the latest main before submitting.

🧑‍💻 For internal contributors:
Use the main branch for maintenance or version bumps only, all features and fixes should go through a feature branch and PR review.

Code style

  • Use TypeScript for all new code.
  • Follow the existing folder and file structure.
  • Keep logic focused and predictable (especially for build output handling).
  • Write meaningful commit messages (use Conventional Commits).

Before you submit

  • Ensure the package builds successfully.
  • Run tests and confirm all pass.
  • Verify output structure matches expected exports.
  • Fix any lint or TypeScript errors.
  • Rebase if your branch is behind main.

Thank you

We truly appreciate your contribution!
Whether it’s fixing output structure, improving exports handling, or refining the build process — you’re awesome. ✨

Made with ❤️ by @rzl-app.