/blame-detective

Empowering Developers to Track and Expose Code Alterations! 🕵️ 🔎

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn Logo


Logo

Blame Detective

Empowering Developers to Track and Expose Code Alterations! 🕵️
Explore the docs

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

cover.webm

Blame Detective is a highly efficient and user-friendly application designed to streamline the process of bug tracking and debugging in software development projects. By leveraging its powerful features, Blame Detective empowers developers to identify and resolve bugs quickly and effectively, saving valuable time and resources.

Blame Detective aims to revolutionize the bug tracking process by providing developers with a comprehensive set of tools to expedite bug resolution. By pinpointing the exact file responsible for the bug, developers can significantly reduce debugging time and enhance overall productivity.

(back to top)

Built With

  • React
  • Vite
  • Tailwind CSS
  • DaisyUI
  • GitHub API

(back to top)

Getting Started

Thank you for choosing Blame Detective for your bug tracking and debugging needs. Follow the instructions below to set up and use the application.

Prerequisites

Before installing Blame Detective, ensure that you have the following prerequisites:

Node.js and npm (Node Package Manager) installed on your machine. You can download them from https://nodejs.org.

  • npm 
    npm install npm@latest -g

Installation

To install and run Blame Detective locally, please follow these steps:

  1. Clone the GitHub repository to your local machine using the following command:

    git clone https://github.com/alexandrelam/blame-detective.git

    Alternatively, you can download the repository as a ZIP file and extract it to your preferred location.

  2. Navigate to the project directory:

    cd blame-detective

  3. Install the required npm packages by running the following command:

    npm ci

  4. Run the application using the following command:

    npm run dev

  5. Open your web browser and access the application at http://localhost:5173/.

(back to top)

Usage

Blame Detective offers a range of powerful features to streamline the bug tracking and debugging process. Here are some examples of how you can effectively use the application:

Example 1: Tracking Bug Introduction by Analyzing Modified Files within a Date Range

Specify the desired date range within Blame Detective to focus on specific periods of time.

Blame Detective will analyze the modification timestamps of your project files and display a comprehensive list of files that were modified within the specified range.

Review the list of modified files to identify potential candidates responsible for introducing bugs during that timeframe.

Example 2: Conducting Advanced Text Searches

Utilize the powerful text search functionality provided by Blame Detective to locate specific code snippets or lines related to a bug.

Enter relevant search terms or apply regular expressions to narrow down your search to specific lines, functions, or variables.

Blame Detective will display the files that contain the matching text, allowing you to focus your attention on those specific code sections for bug investigation and resolution.

Example 3: Including and Excluding Files with Regular Expressions

Leverage the flexibility of regular expressions within Blame Detective to include or exclude specific files from analysis.

Craft custom regular expressions to precisely target the files that need to be analyzed, saving time and effort.

Refine your bug tracking efforts by excluding irrelevant files or narrowing down the search to a specific subset of files based on their names or paths.

(back to top)

Other

Open git diff from authors in vscode

git log --author="Alex\|Vincent" --pretty=format:%H | while read commit_hash; do git show "$commit_hash"; done | code -c "set ft=diff" -

Roadmap

  • CI / CD

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/alexandrelam/blame-detective

(back to top)

Acknowledgments

(back to top)