juspay/services-flake

Template to add a new service

Open

#53 opened on Sep 7, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Nix (63 forks)github user discovery
good first issue

Repository metrics

Stars
 (737 stars)
PR merge metrics
 (Avg merge 8d 1h) (10 merged PRs in 30d)

Description

A just command that takes the service name as an argument and creates nix/<service-name>.nix and nix/<service-name>_test.nix with a hello-world service example.

  • Maybe also add the files in the respective lists of nix/default.nix and test/flake.nix?

  • Update README to add the service

  • Comments specifying to take inspiration from either the nixos module or devenv module if either of them already implement the service.

Contributor guide

Research direction
Look at existing services in the nix/ directory to understand the file structure. Create a just command that takes a service name and generates nix/<service name>.nix and nix/<service name> test.nix based on a hello world example. Also update the file lists in nix/default.nix and test/flake.nix, and add the service to the README. Follow comments to use existing modules if available.
Tech stack
None
Domain
devops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNix
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75