Contributing to PromptCode

March 25, 2025 ยท View on GitHub

Thank you for your interest in contributing to PromptCode! This document provides guidelines and steps for contributing.

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/promptcode.git
  3. Install dependencies: npm install
  4. Build the project: npm run build
  5. Open in VS Code: code .

Development Workflow

  1. Create a new branch for your feature/fix: git checkout -b feature/your-feature-name
  2. Make your changes
  3. Run tests: npm test
  4. Commit your changes with clear messages
  5. Push to your fork
  6. Create a Pull Request

Code Style

  • Follow the existing code style
  • Use TypeScript for new code
  • Add tests for new features
  • Update documentation as needed

Pull Request Guidelines

  • Keep PRs focused and small
  • Include a clear description of changes
  • Reference any related issues
  • Add tests for new features
  • Update documentation if needed

Reporting Issues

  • Use the GitHub issue tracker
  • Include steps to reproduce
  • Add relevant system information
  • Include error messages if applicable

Questions?

Feel free to open an issue for any questions about contributing.