gitea-conventional-comments.../README.md

# Conventional Comments button for gitea

This is a tiny extension that adds a conventional comment button to gitea pull request comments, allowing to quickly leave a structured semantic comment during your PR reviews!

## Attribution

This project was forked from https://gitlab.com/conventionalcomments/conventional-comments-button to make it usable with gitea.

Please see LICENSE file for the original license.

## Demo (needs an update for gitea)

![Demo](demo.gif)

## How to install

First, clone this repo `git clone https://github.com/sebastian-sauer/gitea-conventional-comments-button` and then see below for browser specific instructions.

### Chrome

Recently chrome disallowed to install packed `crx` extension that are not listed on the Chrome Store, so to install this

- On Chrome: Menu
  - More Tools
    - Extensions (be sure to have _Developer Mode_ enabled there)
- In the Extension page: `Load unpacked` and select the cloned repository

### Firefox

- On Firefox: enter `about:debugging#/runtime/this-firefox` into the address bar
- In the Extension page: `Load Temporary Add-on...` and select any file within the cloned repository

## How to update

- `git pull`

### Chrome

- On Chrome: Menu
  - More Tools
    - Extensions
- In the Extension page find `conventional comments button` and hit the refresh button

### Firefox

- On Firefox: enter `about:debugging#/runtime/this-firefox` into the address bar
- In the Extension page find `conventional comments button` and hit the reload button

## How to enable it on a self-hosted instance

- Open the extension options
- Add your domain as a new line in the "Enabled Hosts" field
- Click Save

## Credits

This project bundles some of the icon coming from [font-awesome](https://fontawesome.com/) icons as SVG
Initial changes to make it work with gitea 2023-07-18 19:37:35 +00:00			`# Conventional Comments button for gitea`
Rename extension to proper name 2020-05-22 08:53:47 +00:00
Initial changes to make it work with gitea 2023-07-18 19:37:35 +00:00			`This is a tiny extension that adds a conventional comment button to gitea pull request comments, allowing to quickly leave a structured semantic comment during your PR reviews!`

			`## Attribution`

			`This project was forked from https://gitlab.com/conventionalcomments/conventional-comments-button to make it usable with gitea.`

			`Please see LICENSE file for the original license.`
Rename extension to proper name 2020-05-22 08:53:47 +00:00
Fix clone url in README 2023-07-18 19:41:47 +00:00			`## Demo (needs an update for gitea)`
Update project readme with demo and description 2020-05-22 09:01:49 +00:00
			`![Demo](demo.gif)`

Rename extension to proper name 2020-05-22 08:53:47 +00:00			`## How to install`

Fix clone url in README 2023-07-18 19:41:47 +00:00			First, clone this repo `git clone https://github.com/sebastian-sauer/gitea-conventional-comments-button` and then see below for browser specific instructions.
Removed chrome specific wait for document complete Replaced with extensions API `run_at` in the manifest.json Updated README.md with Firefox instructions 2020-05-22 10:20:06 +00:00
			`### Chrome`

			Recently chrome disallowed to install packed `crx` extension that are not listed on the Chrome Store, so to install this
Rename extension to proper name 2020-05-22 08:53:47 +00:00
			`- On Chrome: Menu`
Update project readme with demo and description 2020-05-22 09:01:49 +00:00			`- More Tools`
Improve install instructions 2021-06-16 07:59:15 +00:00			`- Extensions (be sure to have _Developer Mode_ enabled there)`
Rename extension to proper name 2020-05-22 08:53:47 +00:00			- In the Extension page: `Load unpacked` and select the cloned repository

Removed chrome specific wait for document complete Replaced with extensions API `run_at` in the manifest.json Updated README.md with Firefox instructions 2020-05-22 10:20:06 +00:00			`### Firefox`

			- On Firefox: enter `about:debugging#/runtime/this-firefox` into the address bar
			- In the Extension page: `Load Temporary Add-on...` and select any file within the cloned repository

Rename extension to proper name 2020-05-22 08:53:47 +00:00			`## How to update`

			- `git pull`
Removed chrome specific wait for document complete Replaced with extensions API `run_at` in the manifest.json Updated README.md with Firefox instructions 2020-05-22 10:20:06 +00:00
			`### Chrome`

Rename extension to proper name 2020-05-22 08:53:47 +00:00			`- On Chrome: Menu`
Update project readme with demo and description 2020-05-22 09:01:49 +00:00			`- More Tools`
			`- Extensions`
Rename extension to proper name 2020-05-22 08:53:47 +00:00			- In the Extension page find `conventional comments button` and hit the refresh button
Removed chrome specific wait for document complete Replaced with extensions API `run_at` in the manifest.json Updated README.md with Firefox instructions 2020-05-22 10:20:06 +00:00
			`### Firefox`

			- On Firefox: enter `about:debugging#/runtime/this-firefox` into the address bar
			- In the Extension page find `conventional comments button` and hit the reload button
updated README.md 2020-07-13 09:01:12 +00:00
Change hosts delimiter to new line Added options page accessible via action 2022-04-04 01:17:41 +00:00			`## How to enable it on a self-hosted instance`
updated README.md 2020-07-13 09:01:12 +00:00
Change hosts delimiter to new line Added options page accessible via action 2022-04-04 01:17:41 +00:00			`- Open the extension options`
			`- Add your domain as a new line in the "Enabled Hosts" field`
			`- Click Save`
feat: bundle and serve font awesome icons 2020-08-03 07:33:23 +00:00
			`## Credits`

			`This project bundles some of the icon coming from [font-awesome](https://fontawesome.com/) icons as SVG`