Contributing

• abyss accepts contributions from the community, including but not limited to adding, updating app manifests.
• The format of commit message:
  • Add app manifest: Publisher.PackageIdentifier: add version X.Y.Z
  • Fix and update version: Publisher.PackageIdentifier: update to version X.Y.Z, fix xxx

TIP

• Unlike the official bucket, abyss has some special definitions.
• Refer to existing manifests to familiarize yourself with abyss's manifest definition.
• abyss provides strict JSON Schema for app manifests.
  • Please use vscode, or other code editors built based on it.
  • Please install abgox.json-schema-plus extension.
  • In writing manifests, you will have autocomplete prompts and validation.
  • You can also hover over the properties to view related descriptions.

Adding App Manifests

TIP

• The manifest naming format: Publisher.PackageIdentifier
• If it already exists in winget-pkgs, then refer to the naming in winget-pkgs.
• Here, we assume that we want to add abgox.test.

1. In bucket/a/abgox directory, create abgox.test.json file.

2. Follow the prompts and warnings to complete the manifest definition.

   • You can quickly generate the manifest template by typing scoop-manifest and pressing Tab key.
   • More code snippets can be found in .vscode/scoop-manifest.code-snippets.

3. Run the script for formatting and validation before submitting a PR.

   .\script\sort-json.ps1

   .\script\check-schema.ps1

Updating App Manifests

1. Modify the corresponding JSON manifest file.

2. Run the script for formatting and validation before submitting a PR.

   .\script\sort-json.ps1

   .\script\check-schema.ps1