Skip to content
This repository was archived by the owner on Mar 8, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (84 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

123 lines (84 loc) · 2.08 KB

Contributing to CodeFlow Website

Thank you for your interest in contributing to the CodeFlow website! This document provides guidelines specific to the website.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up development environment: 
    npm install
  4. Create a branch for your changes

Development Workflow

Prerequisites

  • Node.js 20+
  • Next.js knowledge
  • React/TypeScript experience

Running Locally

# Development server
npm run dev

# Build
npm run build

# Start production server
npm start

Code Style

  • Follow ESLint configuration
  • Use Prettier for formatting
  • Use TypeScript for all new code
  • Follow Next.js best practices
  • Use Tailwind CSS for styling

Before committing:

npm run lint
npm run format
npm run type-check

Testing

# Run tests
npm test

# Run with coverage
npm run test:coverage

Target Coverage: >60% for pages

Pull Request Process

  1. Update CHANGELOG.md with your changes
  2. Ensure tests pass and coverage is maintained
  3. Test locally in development and production modes
  4. Update documentation as needed
  5. Create a pull request with a clear description

PR Checklist

  • Code follows style guidelines
  • Tests added/updated
  • Site tested locally
  • Documentation updated
  • CHANGELOG.md updated
  • Responsive design verified

Commit Message Format

Follow Conventional Commits:

feat(website): add pricing page

Create new pricing page with tier comparison.
Add responsive design and animations.

Closes #123

Reporting Issues

Use GitHub Issues with:

  • Clear description
  • Steps to reproduce
  • Expected vs actual behavior
  • Browser and OS information
  • Screenshots if applicable

Questions?

  • GitHub Discussions: For questions
  • GitHub Issues: For bugs and features
  • See main CONTRIBUTING guide for more details

Thank you for contributing! 🎉