Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

104 lines (74 loc) · 2.75 KB
Raw

Contributing to Commit Hub

Thank you for considering contributing to Commit Hub! Your support and contributions are what make this project better.

Getting Started

Prerequisites

  1. Make sure you have Git installed.
  2. Install the required tools and dependencies for the project. Check the README for setup instructions.

Fork and Clone the Repository

  1. Fork the repository by clicking the "Fork" button at the top of this page.

  2. Clone your fork:

    git clone https://github.com/akhil683/Commit-Hub.git

  3. Navigate to the project directory:

    cd Commit-Hub

Set Up the Project

  1. Install dependencies:

    npm install

  2. Start the development server:

    npm run dev

  3. Open your browser and navigate to http://localhost:3000.

How to Contribute

Reporting Bugs

  1. Check the issue tracker to ensure the bug hasn't been reported yet.
  2. Open a new issue with the following details:
    • A clear and descriptive title.
    • Steps to reproduce the problem.
    • Expected vs. actual behavior.

Suggesting Features

  1. Search the issue tracker to check if the feature has already been suggested.
  2. If not, create a new issue with the following details:
    • A descriptive title.
    • Why the feature would be useful.
    • Any examples or mockups (if applicable).

Submitting Changes

  1. Create a new branch for your feature or bugfix:

    git checkout -b feature/my-feature

  2. Make your changes and test them thoroughly.

  3. Format your code and ensure it adheres to the project's coding standards:

    npm run lint
npm run format

  4. Commit your changes with a meaningful message:

    git commit -m "feat: add new feature"

  5. Push your branch to your fork:

    git push origin feature/my-feature

  6. Open a pull request (PR) on the main repository and provide the following details:

    • A descriptive title.
    • A brief summary of changes.
    • Any relevant issue numbers.

Style Guide

  • Use TypeScript for type safety.
  • Follow project-specific conventions detailed in the README.
  • Use meaningful commit messages with prefixes like:
    • feat: for new features.
    • fix: for bug fixes.
    • docs: for documentation changes.
    • style: for formatting changes.

Need Help?

If you have any questions, feel free to reach out by creating a discussion or contacting the me.

Thank you for contributing to [Commit Hub]! Together, we can make it better.