Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (38 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

67 lines (38 loc) · 2.51 KB

Contributing to VUP

VUP is a community-driven repository. Packages and improvements welcome.

Repository Structure

vup/srcpkgs/<category>/<pkgname>/template
vuru/                                     # package manager (Odin)

Adding a Package

  1. Fork the repo.

  2. Pick a category: core, utilities, editors, messenger, programming. If your package doesn't fit, open an issue first.

  3. Create your template at vup/srcpkgs/<category>/<pkgname>/template. Follow standard Void packaging conventions.

  4. Open a PR. CI will check if it builds (a bot will comment incase of issues with logs), after it is merged CI will build your package automatically.

That's it. Once merged, the package shows up in the VUP index.

Template Notes

Follow the Void manual, but a few VUP-specific things:

Electron/prebuilt apps: Set noshlibprovides=yes. This prevents the package from advertising its bundled libraries (like libffmpeg.so) to the system, which breaks dep resolution for other packages.

Maintainer field: Put your name/email. You're responsible for updates.

License: Be accurate. We don't audit this, but users should know what they're installing.

Policy

VUP has no content restrictions. If it builds, it's accepted.

This is intentional. Like the AUR, we're a build system, not a software review board. We verify the template syntax and that the build succeeds. We don't verify if the software is safe, legal, maintained or sane.

Liability

Use at your own risk.

Packages are submitted by random people on the internet. We only check that the manifest builds. We don't:

  • Audit source code
  • Check for malware
  • Verify licenses
  • Guarantee anything works

By using VUP, you accept responsibility for what you install. If you're paranoid (and you should be), read the template before installing.

Architecture

VUP runs entirely on GitHub infrastructure:

Build: GitHub Actions builds packages on push to main. Only modified categories rebuild.

Distribution: Each category has a GitHub Release (e.g. {category-{architecture}-current). The *.xbps, *.xbps.sig2 files and {architecture}-repodata are release assets. These releases act as standard XBPS repositories.

Index: A public/index.json on GitHub Pages maps package names to categories, architectures and versions. vuru fetches this to find packages.

Updating Packages

Bump the version or revision in the template and push. CI handles the rest.