Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

94 lines (65 loc) · 2.63 KB

Contributing to Prompt Dashboard

Thank you for your interest in contributing to Prompt Dashboard! This document provides guidelines and instructions for contributing to this project.

🌟 Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

🔄 Development Workflow

  1. Fork the repository
  2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Run tests and ensure your code passes linting: npm run lint
  5. Commit your changes with descriptive commit messages
  6. Push your branch to your fork: git push origin feature/your-feature-name
  7. Open a Pull Request against the main branch

🏗️ Project Setup

# Clone your fork
git clone https://github.com/your-username/prompt-dashboard.git

# Navigate to the project directory
cd prompt-dashboard

# Install dependencies
npm install
# or
bun install

# Start the development server
npm run dev
# or
bun run dev

📋 Pull Request Process

  1. Ensure your code follows the project's coding standards
  2. Update the README.md or documentation with details of changes if needed
  3. Update the CHANGELOG.md with details of your changes in the Unreleased section
  4. The PR should work in all supported browsers and devices
  5. PRs will be merged once reviewed and approved

🧪 Testing

  • Write tests for new functionality
  • Run existing tests to make sure they still pass with your changes
  • Use npm run test or bun run test to run tests

📝 Coding Style

This project follows the following coding styles:

  • TypeScript with strict types
  • React functional components with hooks
  • Tailwind CSS for styling
  • ESLint and Prettier for code formatting

🛠️ Feature Requests

If you have ideas for new features or improvements:

  1. Check if the feature is already being worked on or has been discussed
  2. Open a new issue describing the feature and its potential benefits
  3. Discuss with maintainers before starting work on major changes

🐛 Bug Reports

When reporting bugs, please include:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Environment information (browser, OS, etc.)

📦 Commit Message Format

  • Use clear, descriptive commit messages
  • Format: type(scope): message (e.g., feat(prompt): add prompt templates)
  • Types: feat, fix, docs, style, refactor, test, chore

📬 Contact

If you have questions or need help, you can:

Thank you for contributing! ✨