Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (37 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

49 lines (37 loc) · 2.05 KB

Contributing to X Linux

Thank you for considering contributing! To maintain the quality and reproducibility of the X Linux ecosystem, please follow these guidelines.

Table of Contents

How to Contribute • Project Structure • Rules

How to Contribute

  1. Fork the repository to your own GitHub account.
  2. Create a branch for your feature, fix, or profile adjustment (git checkout -b feat/new-package-support).
  3. Commit your changes with clear and descriptive messages, ensuring scripts remain executable.
  4. Push to your branch and open a Pull Request against the main branch.

Project Structure

  • airootfs/: Root filesystem overlay where branding, hooks, and system configurations reside.
  • Build Scripts (xbuild.sh / xbuildwsl.sh): Tools for ISO and WSL image generation.
  • pacman.conf & packages.x86_64: Core configuration for repository management and package lists.

Rules

  • Always respect the Code of Conduct in all interactions.
  • Ensure any changes to profiledef.sh or mkarchiso configurations are tested for build success.
  • Do not include sensitive data, personal SSH keys, or private API tokens in the airootfs.
  • For reporting security vulnerabilities, please refer directly to our SECURITY.md.

By contributing, you agree that your code will be licensed under the project's respective licenses (MIT for build scripts and configuration).

Thank you for helping us improve X Linux!