http-nu icon indicating copy to clipboard operation
http-nu copied to clipboard

docs: add NixOS packaging documentation

Open cboecking opened this issue 5 months ago • 0 comments

This PR adds comprehensive documentation for packaging and maintaining http-nu in nixpkgs.

Changes

  • NIXOS_PACKAGING_GUIDE.md: Complete step-by-step guide covering:

    • Package definition structure and components
    • Initial packaging process with hash generation
    • Submitting to nixpkgs and responding to review feedback
    • Maintaining packages with updates
    • Real lessons learned from packaging http-nu v0.5.0 (PR #458947)
    • Common issues and solutions
  • NIXOS_QUICK_REFERENCE.md: Quick command reference for:

    • Package creation workflow
    • Update workflow
    • Testing commands
    • Commit message format
    • Useful checklists
  • package.nix.example: Example package definition file showing the structure used in nixpkgs

  • README.md: Added NixOS installation section with links to the new documentation

Context

These docs were created based on real experience packaging http-nu for nixpkgs, including lessons learned from the review process. They provide both comprehensive guidance for newcomers and quick reference for experienced packagers.

The documentation is designed to help future contributors maintain the nixpkgs package and could be useful for anyone wanting to package similar Rust applications.

cboecking avatar Nov 06 '25 15:11 cboecking