Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (54 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

77 lines (54 loc) · 1.88 KB

Contributing to FlowPilot

Thank you for your interest in contributing to FlowPilot! We welcome contributions from the community.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/flowpilot.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes locally
  6. Commit your changes: git commit -m 'Add some feature'
  7. Push to your branch: git push origin feature/your-feature-name
  8. Open a Pull Request

Development Setup

# Install dependencies
pnpm install

# Copy environment variables
cp env.example .env.local

# Start development server
pnpm dev

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused

Commit Messages

  • Use clear and meaningful commit messages
  • Start with a verb in present tense (e.g., "Add", "Fix", "Update")
  • Keep the first line under 50 characters
  • Add detailed description if needed

Pull Request Guidelines

  • Ensure your code builds without errors
  • Update documentation if needed
  • Add tests for new features
  • Keep PRs focused on a single feature or fix
  • Reference any related issues

Reporting Bugs

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

  • A clear title and description
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Your environment (OS, browser, Node version, etc.)

Feature Requests

We welcome feature requests! Please create an issue with:

  • A clear title and description
  • Use case and motivation
  • Possible implementation approach (optional)

Questions?

Feel free to open an issue for any questions or discussions.

License

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