Skip to content

CONTRIUBUTION.md

Latest commit

 

History

History
113 lines (80 loc) · 2.24 KB

CONTRIUBUTION.md

File metadata and controls

113 lines (80 loc) · 2.24 KB

Contribution Guide

Thank you for contributing to this project! 🚀

We welcome all kinds of contributions including bug fixes, features, documentation improvements, and design enhancements.

Getting Started

  1. Fork the repository
  2. Clone your fork locally: git clone https://github.com/your-username/project-name.git
  3. Navigate to the project directory : cd project-name
  4. Install dependencies : npm install
  5. Start the development server : npm start

Contribution Workflow

  • Check existing issues before creating a new one
  • Comment on the issue you want to work on
  • Create a new branch
  • Make your changes
  • Test your changes properly
  • Commit and push your changes
  • Open a Pull Request
  • Branch Naming Convention

Use meaningful branch names.

Examples

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

Prefixes

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

Use short and meaningful commit messages.

Examples

  • Add responsive navbar
  • Fix login validation bug
  • Update CONTRIBUTION.md

Avoid vague messages like:

  • update
  • changes
  • fixed stuff
  • Pull Request Guidelines

Before submitting a PR:

  • Ensure the project builds successfully
  • Test your changes properly
  • Keep PRs focused on a single issue
  • Write a clear PR title and description
  • Link related issues properly

Example

  • Fixes #12
  • Coding Style Expectations
  • Write clean and readable code
  • Use meaningful variable and function names
  • Keep functions modular and focused
  • Add comments where necessary
  • Follow the existing project structure and formatting

Reporting Bugs

When reporting a bug, include:

  • Steps to reproduce
  • Expected behavior
  • Screenshots (if applicable)
  • Environment details
  • Suggesting Features

Feature suggestions are welcome.

Please include:

  • A clear title
  • Feature description
  • Why the feature would be useful
  • Code of Conduct

By contributing, you agree to follow the project's CODE_OF_CONDUCT.md.

Please be respectful and supportive toward other contributors.

Need Help?

Feel free to:

  1. Open an issue
  2. Start a discussion
  3. Ask maintainers for guidance

Happy Contributing! 🎉