aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDarius Jahandarie <djahandarie@gmail.com>2023-10-01 12:43:45 +0900
committerGitHub <noreply@github.com>2023-10-01 12:43:45 +0900
commit0fbfeb883eb4ca03b9a802757138fef9a6835cdc (patch)
treed752d7594d8302f149eb6aa30485a324ab7aa883 /CONTRIBUTING.md
parentea1c147730bef183855f5dc079c9a2d19e1c623e (diff)
parent0fa8d441a269b13474e6ad4108f49497d4d3abfd (diff)
Merge branch 'master' into dependabot/github_actions/cardinalby/schema-validator-action-3.0.0
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ffc76b74..0b0d722c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,10 +1,10 @@
# Issues and Features
-Issues reported on [GitHub](https://github.com/FooSoft/yomichan/issues) should include information about:
+Issues reported on [GitHub](https://github.com/themoeway/yomitan/issues) should include information about:
* What the problem, question, or request is.
* What browser is being used.
-* What version of Yomichan is being used.
+* What version of Yomitan is being used.
* If applicable, an export of the settings file.
# Development
@@ -21,7 +21,7 @@ Below are a few guidelines to ensure contributions have a good level of quality
## Setup
-Yomichan uses [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) tools for building and testing.
+Yomitan uses [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) tools for building and testing.
After installing these Node.js, the development environment can be set up by running `npm ci`.
## Testing
@@ -50,9 +50,10 @@ Several command line arguments are available for these scripts:
* `[target]` - Builds a specific target.
* `--all` - Builds all targets specified in [manifest-variants.json](dev/data/manifest-variants.json).
* `--default` - Restores the default manifest file.
-* `--manifest <target>` - Overwrites [ext/manifest.json](ext/manifest.json) with the manifest variant for the specified build target.
+* `--manifest <target>` - Overwrites `ext/manifest.json` with the manifest variant for the specified build target.
* `--dry-run` - Runs the full build process (excluding zip building), checking that the configuration is valid.
* `--dry-run-build-zip` - If `--dry-run` is also specified, zip building will also be performed in memory; no files are created.
+* `--yomitan-version <version>` - Sets the version number in the extension manifest. Defaults to 0.0.0.0 if not set.
If no arguments are specified, the command is equivalent to `build.bat --all`.
@@ -66,11 +67,8 @@ Otherwise, the [JSZip](https://stuk.github.io/jszip/) API is used to generate th
## Manifest
Manifest variants for different build targets are specified in [manifest-variants.json](dev/data/manifest-variants.json).
-This file is used to overwrite the [manfiest.json](ext/manifest.json) file included in the extension.
-By default, this manifest should be the default `chrome` manifest, and changes to [manfiest.json](ext/manifest.json) should not be committed
-unless there is a corresponding change in [manifest-variants.json](dev/data/manifest-variants.json).
-There is a continuous integration test which validates this, and the default manifest can be restored by running
-`build.bat --default`.
+This file is used to generate the `ext/manifest.json` file included in the extension.
+The generated `ext/manfiest.json` should not be committed.
## Style