Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (44 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

62 lines (44 loc) · 1.35 KB

Contributing to Prehacks

Thank you for your interest in contributing to Prehacks! This document provides guidelines and information for contributors.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your feature or bugfix
  4. Make your changes
  5. Add tests for your changes
  6. Ensure all tests pass
  7. Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/yourusername/prehacks.git
cd prehacks

# Install dependencies
npm install  # or appropriate package manager

# Run tests
npm test

# Run linting
npm run lint

Code Style

  • Follow the existing code style and conventions
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Ensure your code is properly formatted

Testing

  • Write tests for new features
  • Ensure existing tests continue to pass
  • Aim for good test coverage

Pull Request Process

  1. Update the CHANGELOG.md with your changes
  2. Ensure your PR description clearly explains what was changed and why
  3. Link any related issues
  4. Request review from maintainers

Reporting Issues

When reporting issues, please include:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details (OS, version, etc.)

Questions?

Feel free to open an issue for questions or discussions.