Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 1.43 KB

File metadata and controls

69 lines (48 loc) · 1.43 KB

Contributing Guide

Thank you for your interest in contributing! 🎉
This project welcomes beginners and experienced contributors alike.


Setup Instructions

  1. Fork the repository.

  2. Clone your fork: git clone https://github.com/your-username/project-name.git

  3. Move into the project directory: cd project-name

  4. Install dependencies: npm install

  5. Start the development server: npm run dev

Contribution Workflow

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Commit your work
  5. Push the branch to your fork
  6. Open a Pull Request (PR)

Branch Naming Convention

Use clear and descriptive branch names:

  • feature/add-login-page
  • fix/navbar-bug
  • docs/update-readme

Recommended prefixes:

  • feature/ → New features
  • fix/ → Bug fixes
  • docs/ → Documentation updates
  • refactor/ → Code improvements

Pull Request (PR) Guidelines

Before opening a PR:

  • Ensure the project builds successfully
  • Test your changes properly
  • Keep PRs focused on one task
  • Write a clear PR title and description

Example PR title: Add responsive navbar component

Coding Style Expectations

  • Write clean and readable code
  • Use meaningful variable and function names
  • Keep functions small and focused
  • Add comments where necessary
  • Follow existing project structure and formatting

Need Help?

If you are stuck or unsure, feel free to open an issue or ask questions in discussions. Happy Contributing! 🚀