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
Do not open an issue without first checking the [discussion](https://github.com/cmolisee/session-storage-hub/discussions) forums and starting a new post.
If you find a bug in the source code, you can help us by starting a new post in the [discussion](https://github.com/cmolisee/session-storage-hub/discussions) forum and submitting a new issue.
18
+
If you find a bug in the source code, you can help us by starting a new post in
19
+
the [discussion](https://github.com/cmolisee/session-storage-hub/discussions)
20
+
forum and submitting a new issue.
17
21
18
-
Please link the discussion post in the body of the issue and provide sufficient information:
19
-
- how was the issue discovered
20
-
- how to replciate the issue
22
+
Please link the discussion post in the body of the issue and provide sufficient
23
+
information:
24
+
25
+
- how was the issue discovered
26
+
- how to replciate the issue
21
27
22
28
## Feature
23
29
24
-
You can *request* a new feature by starting a [discussion](https://github.com/cmolisee/session-storage-hub/discussions).
4. In your forked repository, make your changes in a new git branch:
45
55
46
-
```shell
47
-
git checkout -b my-fix-branch main
48
-
```
56
+
```shell
57
+
git checkout -b my-fix-branch main
58
+
```
49
59
50
-
5. Create your patch, **including appropriate test cases** (NOT CURRENTLY REQUIRED. NO TESTS IMPLEMENTED AS OF 10/08/23). You must ensure your code is linted, formatted, and builds. It is also necessary to ensure you thoroughly smoke and regression testin the browser.
60
+
5. Create your patch, **including appropriate test cases** (NOT CURRENTLY
61
+
REQUIRED. NO TESTS IMPLEMENTED AS OF 10/08/23). You must ensure your code is
62
+
linted, formatted, and builds. It is also necessary to ensure you thoroughly
63
+
smoke and regression testin the browser.
51
64
52
65
6. Follow our [Coding Rules](#rules).
53
66
54
-
7. You should make small and descriptive commits throughout development. Release notes and versioning is handled automatically based on commits.
67
+
7. You should make small and descriptive commits throughout development. Release
68
+
notes and versioning is handled automatically based on commits.
55
69
56
70
8. Push your branch to GitHub.
57
71
58
72
9. In GitHub, send a pull request to `main`.
59
73
60
74
### Reviewing a Pull Request
61
75
62
-
Your Pull Request must be reviewed and approved before it can be merged. There is no garuntee that your PR will be approved and/or merged. There may be additional requirements or requests before the PR is accepted, approved, and/or merged.
76
+
Your Pull Request must be reviewed and approved before it can be merged. There
77
+
is no garuntee that your PR will be approved and/or merged. There may be
78
+
additional requirements or requests before the PR is accepted, approved, and/or
79
+
merged.
63
80
64
81
#### After your pull request is merged
65
82
66
-
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository.
67
-
Your branch will automatically be deleted in the origin.
83
+
After your pull request is merged, you can safely delete your branch and pull
84
+
the changes from the main (upstream) repository. Your branch will automatically
85
+
be deleted in the origin.
68
86
69
87
## Coding Rules
70
-
To ensure consistency throughout the source code, keep these rules in mind as you are working:
71
88
72
-
* Test your changes.
73
-
* Document your code.
74
-
* Avoid hard to read code, nested blocks more than 4 levels, obscure code, inefficient code.
89
+
To ensure consistency throughout the source code, keep these rules in mind as
90
+
you are working:
91
+
92
+
- Test your changes.
93
+
- Document your code.
94
+
- Avoid hard to read code, nested blocks more than 4 levels, obscure code,
95
+
inefficient code.
75
96
76
97
## Commits
77
98
@@ -89,26 +110,28 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
2. Change directory to the location you cloned the repo in and install dependencies.
53
+
54
+
2. Change directory to the location you cloned the repo in and install
55
+
dependencies.
56
+
52
57
```
53
58
cd <location>
54
59
npm i
55
60
```
61
+
56
62
3. Build the project.
63
+
57
64
```
58
65
npm run build
59
66
```
67
+
60
68
4. Open your chrome browser and open the extension manager.
61
69
5. Turn on `Developer Mode` and select `Load upacked`.
62
-
6. Select the build folder in the location you built the project. You may need to restart the browser and/or reload tabs.
70
+
6. Select the build folder in the location you built the project. You may need
71
+
to restart the browser and/or reload tabs.
63
72
64
73
### Via Release Artifacts
65
74
66
-
1. Go to the [Releases](https://github.com/cmolisee/session-storage-hub/releases) page and download the Source Code .zip file from the latest release.
67
-
2. Unpack the .zip file into a location of your choice. It will include all source code including the pre-built latest version.
75
+
1. Go to the
76
+
[Releases](https://github.com/cmolisee/session-storage-hub/releases) page and
77
+
download the Source Code .zip file from the latest release.
78
+
2. Unpack the .zip file into a location of your choice. It will include all
79
+
source code including the pre-built latest version.
68
80
3. Open your chrome browser and open the extension manager.
69
81
4. Turn on `Developer Mode` and select `Load upacked`.
70
-
5. Select the build folder in the location you built the project. You may need to restart the browser and/or reload tabs.
82
+
5. Select the build folder in the location you built the project. You may need
83
+
to restart the browser and/or reload tabs.
71
84
72
85
### Upgrading
73
86
74
-
The extension will check for updates the first time you install or about every 5 hours since the last check. If a new version is available it will provide a link to the latest release at the bottom of the extenssion popup window. You can click on that link and follow the steps in the 'Release Artifacts' installation guide above.
87
+
The extension will check for updates the first time you install or about every 5
88
+
hours since the last check. If a new version is available it will provide a link
89
+
to the latest release at the bottom of the extenssion popup window. You can
90
+
click on that link and follow the steps in the 'Release Artifacts' installation
91
+
guide above.
75
92
76
-
Alternatively, if you can follow 'Github and Terminal' installation and pull the latest version from main.
93
+
Alternatively, if you can follow 'Github and Terminal' installation and pull the
94
+
latest version from main.
77
95
78
96
### Basic Usage
79
97
@@ -83,24 +101,35 @@ See the [usage](USAGE.md) documentation on how to use this extension.
83
101
84
102
This extension is built primarily with react, typescript, and sass.
85
103
86
-
Chrome api's are used extensively for browser, tab, and storage functionality and interaction.
104
+
Chrome api's are used extensively for browser, tab, and storage functionality
105
+
and interaction.
87
106
88
-
The extension injects a service worker ('background.js') via the manifest file to each webpage in order to read and write session storage data for each tab. Communication between the service worker and the extension is handled by the content script.
107
+
The extension injects a service worker ('background.js') via the manifest file
108
+
to each webpage in order to read and write session storage data for each tab.
109
+
Communication between the service worker and the extension is handled by the
110
+
content script.
89
111
90
112
All necessary files are minified and pacakged into the build folder.
91
113
92
114
## Issues
93
115
94
-
If you have questions, found a bug, or have an idea on a future additon you can start a [discussion](https://github.com/cmolisee/session-storage-hub/discussions).
116
+
If you have questions, found a bug, or have an idea on a future additon you can
Read through our [contributing guidelines](CONTRIBUTE.md) to learn about our submission process, coding conventions, and other information.
127
+
Read through our [contributing guidelines](CONTRIBUTE.md) to learn about our
128
+
submission process, coding conventions, and other information.
103
129
104
130
## Want to Help or have a Suggestion?
105
131
106
-
To report a bug or submit an idea for a future change? Read the [contribution guidelines](CONTRIBUTE.md), check out the repo issues section, or try the [Discussion Forum](https://github.com/cmolisee/session-storage-hub/discussions).
132
+
To report a bug or submit an idea for a future change? Read the
133
+
[contribution guidelines](CONTRIBUTE.md), check out the repo issues section, or
0 commit comments