Contribution Workflow Guidelines - Nitrux/nx-apphub-apps GitHub Wiki
Thanks for your interest in contributing! This repository houses application specifications for nx-apphub-cli.
Please follow these rules to keep the repo consistent and maintainable.
Want to see your app available through NX AppHub CLI? Follow these steps to contribute an application specification to the NX AppHub Apps repository.
Before you begin, familiarize yourself with:
Reading this information will ensure that your contribution adheres to the system's design and structure.
You can use nx-apphub-cli to generate a template.
Manually review the generated files and:
- Replace REPLACE-ME placeholders (like
binarypath,exec). - Remove unnecessary dependencies. The goal is to fill the gaps, not duplicate the OS (universality is not a requirement).
- Make sure the metadata is clean and well-structured.
Use the template format described in the metadata specification.
- Summary
- Description
- Features
- Requirements
- Homepage
- License
Include at least one screenshot:
- PNG format.
- Placed in
metadata/screenshots/. - Named
screenshot_{1,2,3, etc.}.png.
Fork the repository and create a branch for your app. Then submit a pull request that:
- Adds your app to the correct architecture folder (
x86_64,arm64, etc.) - Includes all required metadata and screenshots.
- Builds correctly with
nx-apphub-cli.
To help reviewers track your contribution, open an issue using this format:
Title: New app: <app-name>
Body:
- App name: <name>
- Description: <short summary>
- Distro: <ubuntu/debian/devuan/kde-neon>
- Architecture: <x86_64 or arm64>
- Build tested with nx-apphub-cli: [yes/no]
- Have any notes or edge cases?
Don't forget to link to the PR regarding the issue for traceability.