Contribution Workflow Guidelines - Nitrux/nx-apphub-apps GitHub Wiki

Introduction

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.

1. How to Contribute an Application

Want to see your app available through NX AppHub CLI? Follow these steps to contribute an application specification to the NX AppHub Apps repository.

1.1 Step 1: Read the Documentation

Before you begin, familiarize yourself with:

Reading this information will ensure that your contribution adheres to the system's design and structure.

1.2 Step 2: Create the app.yml

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.

1.3 Step 3: Write or Edit app_description.md

Use the template format described in the metadata specification.

  • Summary
  • Description
  • Features
  • Requirements
  • Homepage
  • License

1.4 Step 4: Add Screenshots

Include at least one screenshot:

  • PNG format.
  • Placed in metadata/screenshots/.
  • Named screenshot_{1,2,3, etc.}.png.

1.5 Step 5: Open a Pull Request

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.

1.6 Step 6: Open a GitHub Issue

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.

⚠️ **GitHub.com Fallback** ⚠️