Contributing to Form Forge

Thank you for your interest in contributing to Vue Form Forge! I welcome contributions from the community and would love to see how far this can go.

Code of Conduct

By contributing to this project, you agree to abide by our code of conduct. Please treat everyone with respect and and don’t be condescending.

Getting Started

Prerequisites

• Node.js (v16+)
• npm

Note

This is a monorepo setup and all the code is in the packages/* directory. The main vue app has the form builder as a dependency in the package.json file, and the code for the builder is in packages/form-builder/

Project Structure

• Directoryvue-form-forge/

  • Directorypackages/

    • Directoryapp/

      • Directorysrc/

        • …
      • Directorytests/

        • …
    • Directorycli/

      • Directorybin/

        • …
      • Directoryscripts/

        • …
      • Directorysrc/

        • …
    • Directoryform-builder/

      • Directorysrc/

        • …

Setting Up the Development Environment

1. Fork the repository on GitHub

2. Clone your fork locally:

   git clone https://github.com/YOUR_USERNAME/vue-form-forge.git
   cd vue-form-forge

3. Install dependencies:

   npm install

4. Create a new branch for your feature or fix:

   git checkout -b feature/your-feature-name

Ways to Contribute

🐛 Bug Reports

If you find a bug, please create an issue with:

• A clear and descriptive title
• Steps to reproduce the issue
• Expected vs. actual behavior
• Your environment details (Node.js version, Vue version, etc.)
• Code samples or screenshots if applicable

💡 Feature Requests

We love new ideas! When suggesting a feature:

• Check if a similar feature request already exists
• Describe the problem you’re trying to solve
• Provide examples of how the feature would be used
• Consider backwards compatibility

📝 Documentation

Help improve our documentation by:

• Fixing typos or unclear explanations
• Adding examples and use cases
• Improving API documentation
• Writing tutorials or guides

🔧 Code Contributions

Pull Request Process

1. Ensure your code follows our standards:
   • Write clear, readable code
   • Include appropriate comments
2. Test your changes:
   • Add tests for new features (the library uses Vitest and Playwright)
   • Ensure all existing tests pass
   • Test in different Vue and Node versions if applicable
3. Update documentation:
   • Update README.md if needed
   • Update this documentation site if necessary
4. Commit your changes:

   git add .
   git commit -m "feat: add new form validation feature"

5. Push to your fork:

   git push origin feature/your-feature-name

6. Create a Pull Request:
   • Use a clear and descriptive title
   • Write a decent description of your changes
   • Link any related issues

Commit Message Convention

• feat: for new features
• bugfix: for bug fixes
• style: for formatting changes
• refactor: for code refactoring
• test: for adding tests
• chore: for maintenance tasks