Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 2.02 KB

Contributing to DevSignal

Thank you for your interest in contributing to DevSignal. We are building a high-performance engine for developer growth, centered around visual excellence and actionable insights. Your contributions are vital to this mission.

Core Philosophy

We prioritize:

  • Visual Excellence: Every interface element is intentional, utilizing glassmorphism and modern motion design.
  • Immediate Feedback: The application must remain responsive and performant.
  • Narrative Analytics: We aim to tell the story of a developer's growth, not just display raw data.

Getting Started

1. Environment Setup

The project requires Node.js. We use Vite and React for the frontend and Fastify for the backend.

# Clone the repository
git clone https://github.com/TarunyaProgrammer/DevSignal-IntelligentDeveloperGrowth.git
cd DevSignal-IntelligentDeveloperGrowth

# Install dependencies
npm install

# Start the development server
npm run dev

2. Identifying Tasks

Please review the issue tracker for tasks labeled "good first issue" or "visual enhancement." For new feature proposals, please open a Feature Request issue for discussion before beginning implementation.

Submission Process

  1. Feature Branches: Create a dedicated branch for your changes: git checkout -b feature/description
  2. Commit Standards: Use clear, professional commit messages.
  3. Pull Requests: Provide a detailed description of your changes, including screenshots or screen recordings for UI-related modifications.

Project Standards

  • Design Integrity: Maintain the established aesthetic using framer-motion and lucide-react.
  • Code Quality: Adhere to the existing TypeScript patterns and architectural decisions.
  • Professional Conduct: Ensure all interactions remain respectful and constructive.

Recognition

All contributors are recognized in the Hall of Builders (CONTRIBUTORS.md). We value every contribution to the project's growth.

Building the future of developer growth.