Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (55 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

81 lines (55 loc) · 1.97 KB

Contributing to AwesomeUCP

Thank you for your interest in contributing to AwesomeUCP! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

How to Contribute

Reporting Bugs

Before creating a bug report, please check existing issues to avoid duplicates. When creating a bug report, include:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Screenshots if applicable
  • Your environment (OS, browser, Node.js version)

Suggesting Features

Feature requests are welcome! Please provide:

  • A clear description of the feature
  • The problem it solves
  • Any alternative solutions you've considered

Pull Requests

  1. Fork the repository and create your branch from main
  2. Install dependencies: bun install
  3. Make your changes following our coding standards
  4. Test your changes: bun run build
  5. Commit your changes using conventional commits
  6. Push to your fork and submit a pull request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/awesomeucp-web.git
cd awesomeucp-web

# Install dependencies
bun install

# Start development server
bun dev

# Build for production
bun run build

Coding Standards

  • Use TypeScript for all new code
  • Follow existing code style and patterns
  • Use Phosphor Icons for icons
  • Write semantic, accessible HTML
  • Keep components small and focused

Commit Messages

We use conventional commits:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Maintenance tasks

Example: feat: add dark mode toggle to header

Questions?

Feel free to open an issue for any questions or concerns.

Thank you for contributing!