https://github.com/nazdridoy/github-commit-labels

A userscript that enhances GitHub commits by adding beautiful labels for conventional commit types.
https://github.com/nazdridoy/github-commit-labels

commit-message commit-msg github userscript userstyle

Last synced: 4 days ago
JSON representation

A userscript that enhances GitHub commits by adding beautiful labels for conventional commit types.

• Host: GitHub
• URL: https://github.com/nazdridoy/github-commit-labels
• Owner: nazdridoy
• License: mit
• Created: 2025-02-07T03:00:50.000Z (5 days ago)
• Default Branch: main
• Last Pushed: 2025-02-07T03:51:17.000Z (5 days ago)
• Last Synced: 2025-02-07T04:20:11.223Z (5 days ago)
• Topics: commit-message, commit-msg, github, userscript, userstyle
• Language: JavaScript
• Homepage: https://greasyfork.org/en/scripts/526153-github-commit-labels
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Commit Labels

A userscript that enhances GitHub commits by adding beautiful labels for conventional commit types. It automatically detects commit types (like feat, fix, docs) and adds visually appealing labels to make your commit history more readable.

## Features

- 🏷️ Adds beautiful labels to conventional commit messages

- 🎨 GitHub-style design that matches the platform

- ⚙️ Fully customizable through a user-friendly configuration panel

- 🔄 Supports multiple aliases for each commit type

- 🎯 Works on commit history and single commit pages

- 🌙 Optimized for GitHub's dark theme

![2025-02-07_09-17-18](https://github.com/user-attachments/assets/9ad5e643-e2b0-41f9-b332-f0860a631016)

## Supported Commit Types

Default commit types and their aliases:

- **Feature**: `feat`, `feature`

- **Added**: `added`, `add`

- **Updated**: `update`, `updated`

- **Removed**: `removed`, `remove`

- **Fix**: `fix`, `bugfix`, `fixed`

- **Hot Fix**: `hotfix`

- **Documentation**: `docs`, `doc`, `documentation`

- **Style**: `style`, `css`

- **UI**: `ui`

- **Refactor**: `refactor`

- **Performance**: `perf`, `performance`

- **Optimize**: `optimize`

- **Test**: `test`, `tests`, `testing`

- **Build**: `build`

- **CI/CD**: `ci`, `cd`

- **Deploy**: `deploy`, `release`

- **Dependencies**: `deps`, `dep`, `dependencies`

- **Chore**: `chore`

- **Revert**: `revert`

- **WIP**: `wip`

- **You Can ADD More**

  

## Installation

1. Install a userscript manager:

   - [Tampermonkey](https://www.tampermonkey.net/) (Recommended)

   - [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/)

   - [Violentmonkey](https://violentmonkey.github.io/)

2. Install the script:

   - [Install from Greasy Fork](https://greasyfork.org/en/scripts/526153-github-commit-labels)

   - Or create a new script in your userscript manager and copy the contents of `github-commit-labels.js`

## Configuration

1. Click on your userscript manager's icon

2. Select "GitHub Commit Labels" > "Configure Commit Labels"

3. Customize:

   - Add/remove commit types

   - Edit aliases

   - Change emojis

   - Modify colors

   - Toggle prefix removal

  

  ![2025-02-07_09-18-39](https://github.com/user-attachments/assets/a580845e-88ff-40e0-922e-da8247720eed)

## Development

To contribute or modify the script:

1. Clone the repository:

```bash

git clone https://github.com/nazdridoy/github-commit-labels.git

```

2. Make your changes to `github-commit-labels.js`

3. Test the script by loading it in your userscript manager

4. Submit a pull request with your changes

## License

MIT License - see [LICENSE](LICENSE) for details

## Credits

Created by [nazdridoy](https://github.com/nazdridoy)

## Support

If you encounter any issues or have suggestions:

- [Open an issue](https://github.com/nazdridoy/github-commit-labels/issues)

- [Submit a pull request](https://github.com/nazdridoy/github-commit-labels/pulls)