You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,8 @@ Suggestions and pull requests are highly encouraged! Have a look at the [open is
9
9
-[JSX](https://reactjs.org/docs/introducing-jsx.html) is used to create DOM elements.
10
10
- All the [latest DOM APIs](https://github.com/WebReflection/dom4#features) and JavaScript features are available because the extension only has to work in the latest Chrome and Firefox. 🎉
11
11
- Each JavaScript feature lives in its own file under [`source/features`](https://github.com/sindresorhus/refined-github/tree/main/source/features) and it's imported in [`source/refined-github.ts`](https://github.com/sindresorhus/refined-github/blob/main/source/refined-github.ts).
12
-
- See what a _feature_[looks like](https://github.com/sindresorhus/refined-github/blob/main/source/features/user-profile-follower-badge.tsx).
13
-
- Follow [the styleguide](https://github.com/sindresorhus/refined-github/blob/main/readme.md#L62) that appears in the Readme's source to write readable descriptions.
12
+
- See what a feature[looks like](https://github.com/sindresorhus/refined-github/blob/main/source/features/user-profile-follower-badge.tsx).
13
+
- Follow [the styleguide](https://github.com/sindresorhus/refined-github/blob/main/readme.md#L70) that appears in the Readme's source to write readable descriptions.
14
14
- Refined GitHub tries to integrate as best as possible, so [GitHub's own styleguide](https://primer.style/css) might come in useful.
15
15
16
16
## `features.add`
@@ -53,15 +53,15 @@ function init(): void {
53
53
}
54
54
55
55
voidfeatures.add(__filebasename, {
56
-
/** This only adds the shortcut to the help screen, it doesn't enable it.*/
56
+
// This only adds the shortcut to the help screen, it doesn't enable it.
57
57
shortcuts: {
58
58
'↑': 'Edit your last comment'
59
59
},
60
60
61
-
/** Whether to wait for DOM ready before running `init`. `false` makes `init` run right as soon as `body` is found. @defaulttrue*/
61
+
// Whether to wait for DOM ready before running `init`. `false` makes `init` run right as soon as `body` is found. @default true
62
62
awaitDomReady: false,
63
63
64
-
/** Rarely needed: When pressing the back button, the DOM and listeners are still there, so normally `init` isn’t called again. If this is true, it’s called anyway. @defaultfalse*/
64
+
// Rarely needed: When pressing the back button, the DOM and listeners are still there, so normally `init` isn’t called again. If this is true, it’s called anyway. @default false
65
65
repeatOnBackButton: true,
66
66
include: [
67
67
pageDetect.isUserProfile,
@@ -113,4 +113,6 @@ npm run start # Open extension in Chrome
113
113
npm run start:firefox # Open extension in Firefox
114
114
```
115
115
116
+
**Note**: They both require [web-ext](https://github.com/mozilla/web-ext) to be installed globally. Run `npm i -g web-ext`
117
+
116
118
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).
0 commit comments