Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.27 KB

Contributing to Iconcoderz

First off, thanks for taking the time to contribute!

Getting Started

To get your local development environment set up, please read our Getting Started Guide on the documentation site. It covers:

  • Installing Node.js, pnpm, and Docker
  • Setting up Environment Variables
  • Running the Frontend and Backend locally

Workflow

  1. Fork the repository (if you are an external contributor) or Create a Branch.
  2. Pull Request: Open a PR to the main branch.
  3. CI Checks: Ensure all checks pass (Linting, Tests). See our CI/CD Guide for details on the pipeline.

Reporting Bugs

Bugs are tracked as GitHub Issues. Create an issue using the Bug Report template and provide:

  • A clear title and description
  • Steps to reproduce
  • Screenshots (if applicable)

Feature Requests

We welcome new ideas! Please use the Feature Request template to suggest enhancements.

Coding Standards

  • React: Functional components and Hooks.
  • Styling: Tailwind CSS.
  • State: React Context or Local State (avoid over-engineering).
  • Format: We use Prettier/ESLint. Run pnpm lint before committing.

Thanks! The Iconcoderz Team