CONTRIBUTING.md

Contributing to Fluid

Git Workflow

We follow a feature branch workflow to maintain code quality and ensure proper review process.

Branch Naming Convention

• feature/feature-name - New features
• bugfix/bug-description - Bug fixes
• hotfix/urgent-fix - Critical fixes
• docs/documentation-update - Documentation changes

Workflow Steps

1. Create a feature branch

   git checkout -b feature/your-feature-name

2. Make your changes

   • Write clean, documented code
   • Follow existing code style
   • Add tests when appropriate

3. Commit your changes

   git add .
   git commit -m "feat: descriptive commit message"

4. Push to remote

   git push -u origin feature/your-feature-name

5. Create a Pull Request

   • Provide clear description of changes
   • Link related issues
   • Request review from maintainers

6. Code Review

   • Address feedback promptly
   • Keep PR updated with latest changes

7. Merge

   • Only merge after approval
   • Use squash merge for clean history
   • Delete feature branch after merge

Commit Message Convention

We use conventional commits:

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation changes
• style: - Code style changes (formatting, etc.)
• refactor: - Code refactoring
• test: - Adding or updating tests
• chore: - Maintenance tasks

Example:

feat: implement secure admin authentication with nextauth.js (#63)

Main Branch Protection

• Direct pushes to main are disabled
• All changes must go through Pull Requests
• PRs require at least one review
• CI/CD must pass before merge

Development Setup

1. Fork the repository
2. Clone your fork
3. Add upstream remote:

   git remote add upstream https://github.com/devcarole/fluid.git

4. Keep your fork updated:

   git checkout main
   git pull upstream main

Code Quality

• Follow TypeScript best practices
• Use meaningful variable names
• Add JSDoc comments for complex functions
• Ensure no console.log in production code
• Follow existing project structure

Thank you for contributing to Fluid! 🚀