-
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
9,230 additions
and
6,275 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Contributing | ||
|
||
## Requirements | ||
|
||
[Node.js](https://nodejs.org/en/download/) version 16 or later is required. | ||
|
||
## Workflow | ||
|
||
First clone: | ||
|
||
```sh | ||
git clone https://github.com/fregante/github-issue-link-status.git | ||
cd github-issue-link-status | ||
npm install | ||
``` | ||
|
||
The extension can be then build with | ||
|
||
```sh | ||
npm run build | ||
``` | ||
|
||
When working on the extension or checking out branches, use this to have it constantly build your changes: | ||
|
||
```sh | ||
npm run watch # Listen to file changes and automatically rebuild | ||
``` | ||
|
||
Then load or reload it into the browser to see the changes. | ||
|
||
## Loading into the browser | ||
|
||
Once built, load it in the browser of your choice with [web-ext](https://github.com/mozilla/web-ext): | ||
|
||
```sh | ||
npx web-ext run --target=chromium # Open extension in Chrome | ||
``` | ||
|
||
```sh | ||
npx web-ext run # Open extension in Firefox | ||
``` | ||
|
||
Or you can [load it manually in Chrome](https://www.smashingmagazine.com/2017/04/browser-extension-edge-chrome-firefox-opera-brave-vivaldi/#google-chrome-opera-vivaldi) or [Firefox](https://www.smashingmagazine.com/2017/04/browser-extension-edge-chrome-firefox-opera-brave-vivaldi/#mozilla-firefox). |
Oops, something went wrong.