Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
138 lines (108 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

138 lines (108 loc) · 3.08 KB

Contributing to KaloudasDev LinkHub Website

Thank you for your interest in contributing! The goal of this repository is to be a high-quality, resource for developers and showcase modern Next.js practices.

Getting Started

Prerequisites

  • Node.js 18+ installed
  • Git installed
  • Basic knowledge of React/Next.js
  • Understanding of CSS and modern JavaScript

Development Setup

# Fork the repository
# Clone your fork
git clone https://github.com/YOUR_USERNAME/linkhub-website.git

# Navigate to project
cd linkhub-website

# Install dependencies
npm install

# Start development server
npm run dev

How to Contribute

Reporting Issues

If you find a bug, typo, broken link, or have a suggestion:

  1. Check if the issue already exists
  2. Create a new issue with a clear title and description
  3. Include steps to reproduce (if applicable)
  4. Add screenshots for visual bugs

Feature Requests

Have an idea for improvement?

  1. Describe the feature in detail
  2. Explain why it would be valuable
  3. Suggest implementation approach (optional)
  4. Open a feature request issue

Pull Request Process

  1. Create a branch

    git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

  2. Make your changes

    • Follow existing code style
    • Update documentation as needed
    • Test your changes locally

  3. Commit your changes

    git add .
git commit -m "Feat: Added new feature"
git commit -m "Fix: Resolved issue with X"
git commit -m "Docs: Updated README.md"

  4. Push to your fork

    git push origin feature/your-feature-name

  5. Open a Pull Request

    • Clear title describing the change
    • Detailed description of what you changed
    • Reference any related issues
    • Add screenshots for visual changes

Commit Messages

Follow Conventional Commits:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • perf: Performance improvements
  • test: Testing
  • chore: Maintenance

Review Process

What reviewers look for:

  • Code quality and consistency
  • Performance implications
  • Accessibility considerations
  • Mobile responsiveness
  • Cross-browser compatibility
  • Documentation updates

Review timeline:

  • Initial review within 2-3 days
  • Feedback and discussion
  • Changes requested if needed
  • Final approval and merge

Areas for Contribution

High Priority

  • Accessibility improvements
  • Performance optimization
  • Test coverage
  • Documentation updates

Medium Priority

  • New features
  • UI/UX improvements
  • Animation enhancements
  • SEO optimization

Low Priority

  • Code refactoring
  • Dependency updates
  • Comment improvements

Community Guidelines

  • Be respectful and inclusive
  • Provide constructive feedback
  • Help others learn
  • Celebrate contributions
  • Follow the Code of Conduct

Getting Help

Thank you for contributing! Every contribution makes this project better.