Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (46 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 1.67 KB

Contributing to Spread

Thank you for considering contributing to Spread. We value community contributions that enhance the technical and visual quality of this project.

Development Workflow

This project utilizes Bun as the primary runtime and package manager.

Contribution Process

  1. Fork the Repository

  2. Clone the Local Repository

    git clone https://github.com/YOUR-USER/spread.git
cd spread

  3. Dependency Installation

    bun install

  4. Branch Creation

    git checkout -b feature/contribution-name

  5. Implementation Guidelines

    • Adhere to the modular architecture located in src/components.
    • Maintain code quality and ensure consistency with existing styling.
    • Validate implementation locally using bun dev.

  6. Version Control Integration We utilize semantic commit conventions:

    • feat: for functional enhancements
    • fix: for defect resolution
    • docs: for documentation modifications
    • style: for formatting adjustments
    • refactor: for code restructuring
    • test: for test suite updates
    • chore: for developmental maintenance

  7. Synchronization

    git push origin feature/contribution-name

  8. Pull Request Submission

Issue Reporting

Technical issues or feature requests should be submitted via GitHub Issues, including:

  • Detailed technical descriptions.
  • Procedures for reproduction.
  • Expected behavior versus observed behavior.

Code of Conduct

All contributors are expected to maintain professional, respectful, and constructive interactions.

Built with Astro, React, and Tailwind CSS.