Skip to content

Commit b890b04

Browse files
rushilsrivastavarushilsrivastava
committed
✨ Update readme, and repo documentation
Adds new issue template formats, contribution guidelines, etc. Signed-off-by: Rushil Srivastava <[email protected]>
1 parent e23f132 commit b890b04

9 files changed

+169
-77
lines changed

‎.github/CONTRIBUTING.MD

+21-57
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,6 @@
1-
# How to Contribute
1+
# Running this project locally
22

3-
Before create any pull requests, please open a issue explaining the situation
4-
5-
- Be sure to follow the eslint rules and run the prettier
6-
- Be sure **before open the pull request**, to test the existent code and/or create tests if you made a new feature or
7-
changed a already existing one.
8-
9-
## Issues
10-
11-
Should be in the format:
12-
13-
```text
14-
**Type:**
15-
- [x] bug
16-
- [ ] feature
17-
- [ ] enhancement
18-
- [ ] question
19-
20-
**Environment:**
21-
- OS: Windows 10
22-
- Version: 0.6.0
23-
24-
**Going to open a PR:**
25-
- [x] yes
26-
- [ ] no
27-
28-
**Description:**
29-
The messages aren't showing on the console
30-
```
31-
32-
## Pull Requests
33-
34-
- On the description of the pull request set the issue id for closing it:
35-
36-
```text
37-
Now the messages are showing. Closes #41
38-
```
39-
40-
## Following the guideline
41-
42-
Please follow the above rules, so the repo can stay consistent and easy for everyone find questions and
43-
already resolved stuff. Be aware that your PR can be denied if you don't follow then :cry:
44-
45-
## Running this project locally
46-
47-
### Building and Testing
3+
## Building and Testing in Browser
484

495
Inside this repository have an example plugin, so you can test and see it working
506
After cloning the repository, run:
@@ -53,21 +9,29 @@ After cloning the repository, run:
539
npm run build
5410
```
5511

56-
And then run:
12+
And then run:
5713

14+
**Chrome:**
5815
```bash
59-
npm run start:sample
16+
npm run start:sample:chrome
6017
```
6118

62-
This will make the webpack run in watch mode for the sample plugin source and output the built files on the "dist"
63-
directory.
64-
Load the extension **(the files in "sample/dist" directory)** using the "load unpacked extension", open a
65-
new tab in any site and open the developer panel on it. Watch the dev. tools console tab, and do some changes on
66-
the background or content script. Voila!
19+
**Firefox:**
20+
```bash
21+
npm run start:sample:firefox
22+
```
23+
24+
This will make the webpack run in watch mode for the sample plugin source and output the built files on the "dist" directory.
25+
Load the extension **(the files in "sample/dist" directory)** using the "load unpacked extension", open a new tab in any site and open the developer panel on it. Watch the dev. tools console tab, and do some changes on the background or content script. Voila!
6726

6827
**Note:**
69-
You must have both background and content scripts for this plugin to work, and they must be specified in separate `entry` chunks
70-
in your webpack config.
28+
You must have both background and content scripts for this plugin to work, and they must be specified in separate `entry` chunks in your webpack config.
29+
30+
The reloading script will be injected only on the main entries chunks (in background and content script). Any other chunks will be ignored.
31+
32+
33+
## Linting and Unit Tests
34+
35+
In order to lint, simply use the `npm run lint` command. Similarly, to format with Prettier, use the `npm run format` command.
7136

72-
The reloading script will be injected only on the main entries chunks (in background and content script). Any other
73-
chunks will be ignored.
37+
In order to run tests, you can use the `npm run test` command.

‎.github/ISSUE_TEMPLATE.md

-17
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Bug report
3+
about: File a bug report
4+
labels: 'type: bug'
5+
assignees: rushilsrivastava
6+
7+
---
8+
9+
[//]: # (These comments will not show up. You can keep them or delete them, up to you.)
10+
11+
#### Describe the bug
12+
13+
[//]: # (A clear and concise description of what the bug is.)
14+
15+
#### Error Stacks
16+
17+
```bash
18+
put error stacks here
19+
```
20+
21+
#### To Reproduce
22+
23+
##### Config
24+
25+
```javscript
26+
add your webpack config here
27+
```
28+
29+
##### Example
30+
31+
[//]: # (A minimal example to reproduce the behavior if relevant.)
32+
33+
#### Expected behavior
34+
35+
[//]: # (A clear and concise description of what you expected to happen.)
36+
37+
#### Environment:
38+
39+
- OS:
40+
- Browser Version:
41+
- webpack Version:
42+
- webpack-ext-reloader Version:
43+
44+
#### I'm going to open a PR
45+
46+
- [ ] yes
47+
- [ ] no
48+
49+
#### Additional information
50+
51+
[//]: # (Add any addittional infomration about the bug/problem here.)

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Request a feature
4+
labels: 'type: enhancement'
5+
6+
---
7+
8+
[//]: # (These comments will not show up. You can keep them or delete them, up to you.)
9+
10+
#### Describe the feature request
11+
12+
[//]: # (What is your feature request? What are you trying to solve and how are you currently solving it?)
13+
14+
#### Wanted Solution
15+
16+
[//]: # (What type of solution are you looking for? How would it look?)
17+
18+
```javscript
19+
add an example of desired code here if relevant
20+
```
21+
22+
#### I'm going to open a PR
23+
24+
- [ ] yes
25+
- [ ] no
26+
27+
#### Additional information
28+
29+
[//]: # (Add any addittional infomration about the bug/problem here.)

‎.github/ISSUE_TEMPLATE/question.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Question
3+
about: Ask a question
4+
labels: 'type: question'
5+
6+
---
7+
8+
[//]: # (These comments will not show up. You can keep them or delete them, up to you.)
9+
10+
#### Describe the question
11+
12+
[//]: # (A clear and concise description of your question.)
13+
14+
#### Example Code
15+
16+
##### Config
17+
18+
```javscript
19+
add your webpack config here
20+
```
21+
22+
##### Example
23+
24+
[//]: # (A minimal example to reproduce the behavior if relevant.)
25+
26+
#### Environment
27+
28+
- OS:
29+
- Browser Version:
30+
- webpack Version:
31+
- webpack-ext-reloader Version:
32+
33+
#### Additional information
34+
35+
[//]: # (Add any addittional infomration about the bug/problem here.)

‎.github/PULL_REQUEST_TEMPLATE.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
[Write what you PR is]. Closes #[ISSUE_NUMBER]
1+
[//]: # (Briefly describe what your PR is about and/or solves.)
2+
3+
#### Checklist
4+
5+
- [ ] I ran the linting and formatting tools (ESLint and Prettier)
6+
- [ ] I added addittional tests if adding new features
7+
8+
Closes #[ISSUE_NUMBER]

‎.github/release.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
categories:
6+
- title: 🛠 Breaking Changes
7+
labels:
8+
- "type: breaking"
9+
- "type: design"
10+
- title: 🐛 Bug Fixes
11+
labels:
12+
- "type: bug"
13+
- title: 🎉 Exciting New Features
14+
labels:
15+
- "type: enhancement"
16+
- "type: feature"
17+
- title: 🧱 Dependencies
18+
labels:
19+
- "type: dependencies"
20+
- title: Other Changes
21+
labels:
22+
- "*"

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ yarn add webpack-ext-reloader --dev
3131

3232
## What is this?
3333

34-
This is a webpack plugin that allows you to bring hot reloading functionality to WebExtensions, essentially `webpack-dev-server`, but for WebExtensions.
34+
This is a webpack plugin that allows you to bring hot reloading functionality to WebExtensions, essentially `webpack-dev-server`, but for (WebExtensions)[https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions].
3535

3636
This is a fork from [`webpack-extension-reloader`](https://github.com/rubenspgcavalcante/webpack-extension-reloader), maintained and updated by the team here at Simplify. The goal here is to continue to support the latest version of webpack (`webpack-extension-reloader` only supports webpack v4) while adding new improvements (i.e. HMR).
3737

@@ -47,7 +47,7 @@ Add `webpack-ext-reloader` to the plugins section of your webpack configuration
4747
For outputing not only the `manifest.json` but other static files too, use `CopyWebpackPlugin`.
4848

4949
```js
50-
const ExtReloader = require('webpack-ext-reloader');
50+
const ExtReloader = require('webpack-ext-reloader');
5151

5252
plugins: [
5353
new ExtReloader(),

0 commit comments

Comments
 (0)