Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (31 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.29 KB
Raw

Contributing to Vibe Workflow

Thank you for your interest in contributing to Vibe Workflow! We welcome contributions from everyone.

Here are some guidelines to help you get started:

Getting Started

  1. Clone the repository: 
    git clone https://github.com/your-username/vibe-workflow.git
cd vibe-workflow
  2. Install dependencies: 
    npm install
  3. Create a branch for your feature or bugfix: 
    git checkout -b feature/amazing-feature

Development Workflow

  • Frontend: Run npm run dev:app to start the Next.js app.
  • Library: Run npm run build:lib to rebuild the workflow-builder package.
  • Backend: Navigate to server/ and run the FastAPI server.

Submission Guidelines

  1. Ensure your code follows the project's coding standards.
  2. Test your changes locally.
  3. Commit your changes with clear, descriptive messages.
  4. Push your branch to your fork.
  5. Open a Pull Request against the main branch of the original repository.

Reporting Issues

If you find a bug or have a feature request, please search the issue tracker first. If it doesn't exist, feel free to open a new issue.

License

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