Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
151 lines (97 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

151 lines (97 loc) · 3.8 KB

Contributing to Formless

First off, thanks for taking the time to contribute! This project is made better by people like you.

Whether you're fixing a typo, reporting a bug, or proposing a new feature — every contribution matters.

Quick Links

I Have a Question

Before asking:

  1. Check the README — it covers most use cases
  2. Search existing issues — someone might have asked already

Still stuck? Open a Discussion and we'll help out.

I Found a Bug

Great catch! Help us fix it by opening an issue with:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • Browser + OS + React version
  • Which form adapter you're using (RHF, Formik, TanStack)
  • A code snippet (bonus points for a minimal reproduction!)

I Want to Suggest a Feature

We'd love to hear your ideas! Open a feature request and tell us:

  • What problem does this solve?
  • How would the API look?
  • Any alternatives you've considered?

Keep in mind: this library aims to stay small and focused. We may decline features that add significant complexity or bundle size.

I Want to Contribute Code

Awesome! Here's how to get started:

1. Set Up Your Environment

# Fork and clone
git clone https://github.com/YOUR_USERNAME/formless.git
cd formless

# Install dependencies
npm install

# Make sure everything works
npm test

2. Create a Branch

git checkout -b fix/rhf-validation-bug
# or
git checkout -b feat/add-yup-bridge

3. Make Your Changes

A few guidelines:

Do Don't
Write tests for new features Skip tests
Keep changes focused Mix unrelated changes
Follow existing code style Reformat entire files
Update docs if needed Leave outdated docs

4. Test Your Changes

npm run lint        # Check code style
npm run typecheck   # Verify types
npm test            # Run tests
npm run build       # Make sure it builds

5. Commit Your Changes

We use conventional commits:

git commit -m "fix: handle RHF validation mode correctly"
git commit -m "feat: add Yup schema bridge"
git commit -m "docs: add TanStack migration guide"

6. Open a Pull Request

Push your branch and open a PR. Include:

  • What changed and why
  • How to test it
  • Screenshots (if UI-related)

Code Style

  • TypeScript — All code is typed
  • Prettier — Formatting is automatic (runs on commit)
  • ESLint — Linting catches common issues

Don't worry too much about style — our tools handle most of it automatically.

Project Philosophy

This library follows a few principles:

  1. Form agnostic — Works with any supported form library
  2. Small bundle — Minimal overhead on top of your form library
  3. Simple API — Easy to use, hard to misuse
  4. Type safe — Full TypeScript support with intelligent autocomplete

If your contribution aligns with these, we'll likely merge it!

License

By contributing, you agree that your code will be licensed under the MIT License.

Thank You!

Seriously — whether you're fixing a comma or adding a feature, we appreciate you taking the time to make this project better.

Happy coding!