Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (36 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 4.35 KB
Raw

Contributing

  • To contribute content, create a pull request with valid changes/additions to any files in the repo.
  • To test locally, run: npm run dev (you should have Node 22 installed, run npm i once to install dependencies).
  • See ImranR98/Obtainium#1214 for background/context for this repo.

Contributing Apps

Important

Please make sure to read the app criteria before opening a PR with new/updated app configs.

  • You can auto-generate config files from an Obtainium export by running node scripts/generate_from_export.js <path to Obtainium export>
  • Note: Auto-generated entries will not have icon, category, or description data. Adding those manually is not required but would result in a better user experience.
  • You can also auto-generate config files from an Obtainium URL redirection link by running scripts/generate_from_url.py
  • Note: Using scripts/generate_from_url.py requires you to install "Colorama" by using the pip command pip install colorama

Minimal Example

To add an app config to this repo, your app configuration JSON must contain at least the id, url, author, und name keys. Note that for any app-specific setting you don't define in additionalSettings, the default value will be used.

For example:

Beitragen

  • Um Inhalte beizusteuern, erstellen Sie einen Pull-Request mit gültigen Änderungen/Ergänzungen zu allen Dateien im Repo.
  • Um Ihre Änderungen lokal zu testen, führen Sie bitte npm run dev aus
  • Siehe ImranR98/Obtainium#1214 für den Hintergrund/Kontext für dieses Repo.

Apps beisteuern

Important

Bitte stellen Sie sicher, dass Sie die App-Kriterien lesen, bevor Sie einen PR mit neuen/aktualisierten App-Konfigurationen eröffnen.

  • Sie können Konfigurationsdateien automatisch aus einem Obtainium-Export generieren, indem Sie node scripts/generate_from_export.js <Pfad zum Obtainium-Export> ausführen.
  • Hinweis: Automatisch generierte Einträge haben keine Symbol-, Kategorie- oder Beschreibungsdaten. Diese manuell hinzuzufügen ist nicht zwingend erforderlich, ist aber erwünscht, weil es zu einer besseren Benutzerfreundlichkeit führen würde.
  • Sie können auch automatisch Konfigurationsdateien aus einem Obtainium-URL-Umleitungslink generieren, indem Sie scripts/generate_from_url.py ausführen.
  • Hinweis: Die Verwendung von scripts/generate_from_url.py erfordert die Installation von „Colorama“ mit dem pip Befehl pip install colorama.

Minimalbeispiel

Um eine App-Konfiguration zu diesem Repo hinzuzufügen, muss Ihre App-Konfiguration JSON mindestens die Schlüssel id, url, author, und name enthalten. Beachten Sie, dass für jede app-spezifische Einstellung, die Sie nicht in additionalSettings definieren, der Standardwert verwendet wird.

Zum Beispiel: