Skip to content

chore(repo): add userscript, project conventions, CI and README - #1

Merged
hannesgao merged 5 commits into
mainfrom
chore/project-setup
Oct 5, 2026
Merged

hannesgao merged 5 commits into
mainfrom
chore/project-setup

Conversation

@hannesgao

Copy link
Copy Markdown
Owner

Summary

Sets up the repository: adds the Payback Helper userscript with auto-update metadata, contribution conventions, CI checks and an English README.

Changes

  • Add payback-helper.user.js (renamed so userscript managers offer one-click install)
    • Add @license, @homepageURL, @supportURL, @updateURL, @downloadURL
    • Add English @name:en / @description:en
    • Bump @version to 0.2.1; @name and @namespace are unchanged so existing installs keep updating
  • Add .gitignore
  • Add CONTRIBUTING.md (branch naming, Conventional Commits, PR rules, SemVer for @version)
  • Add pull request template
  • Add CI workflow: JS syntax check, metadata block check, PR title check
  • Add README.md with features, install link, usage and limitations

Testing

  • node --check payback-helper.user.js passes
  • Metadata and PR title checks pass locally with the same commands CI runs

Checklist

  • PR title follows Conventional Commits (type(scope): subject)
  • @version bumped if the script's behavior changed
  • Tested manually on https://www.payback.de/coupons
  • README updated if usage or behavior changed

Name the file *.user.js so userscript managers offer one-click install, and add license, homepage, support, update and download URLs plus English name and description. Bump version to 0.2.1.
@hannesgao
hannesgao merged commit f12bf49 into main Oct 5, 2026
2 checks passed
@hannesgao
hannesgao deleted the chore/project-setup branch October 5, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant