Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

95 lines (68 loc) · 2.04 KB

Contributing to JS Playground

Thank you for your interest in contributing to JS Playground! We aim to make this JavaScript playground a powerful tool for developers worldwide.

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Create a new branch
  4. Make your changes
  5. Submit a pull request

Development Setup

# Install dependencies
yarn install

# Start development server
yarn dev

Code Style Guidelines

TypeScript

  • Use TypeScript for all new files
  • Avoid using any type
  • Write proper interfaces and types
  • Use proper type imports/exports

React

  • Use functional components and hooks
  • Keep components small and focused
  • Write meaningful component names
  • Document props using TypeScript interfaces

General

  • Use meaningful variable names
  • Write comments for complex logic
  • Follow existing code formatting
  • Use absolute imports
  • Keep files under 200 lines when possible

Commit Messages

Follow the Conventional Commits specification:

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense
|
+-------> Type: feat, fix, docs, style, refactor, test, or chore

Testing

  • Write tests for new features
  • Update tests for modified code
  • Ensure all tests pass before submitting PR

Documentation

  • Update README.md for new features
  • Document new components and hooks
  • Add JSDoc comments for functions
  • Update type definitions

Pull Request Process

  1. Update the README.md with new features
  2. Update the documentation
  3. Add tests for new functionality
  4. Ensure code passes linting
  5. Request review from maintainers

Code Review

  • Address review feedback promptly
  • Keep discussions professional
  • Be open to suggestions
  • Ask questions if unclear

Additional Notes

  • Start small with your first contribution
  • Join our community discussions
  • Ask for help when needed
  • Be patient with reviews

Thank you for contributing! 🎉