chore: replace the Makefiles with Justfiles

Open
  • Is something wrong?
#345 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, go
Domain
build-system, tooling

Research direction

Start with the three Makefiles: the root Makefile, internal/tests/Makefile, and examples/Makefile, and note which targets run protoc regeneration. The open decisions are one root Justfile or per-directory modules, and how to keep regeneration when the plugin changes, so settle those with the maintainers before editing. Update doc/dev-guide.md, AGENTS.md, and the GitHub workflows that call make. Done means every Makefile target has a Justfile equivalent, the docs and workflows use just, and the generated protobuf code still rebuilds.

Written by the indexing model from the issue text.

Description

cleanup

We have three Makefiles: the root Makefile, internal/tests/Makefile, and examples/Makefile.
They mostly run commands and rely on file timestamps only for the generated protobuf code, which is a poor fit for make.

Replace them with Justfiles.
Things to decide as part of this:

  • One Justfile at the root, or one per directory (just supports modules).
  • How to keep the "regenerate when the plugin changes" behavior that #100 asked for, or whether just genproto is enough.
  • Update the docs (doc/dev-guide.md, AGENTS.md) and the GitHub workflows that call make.

This replaces the Makefile part of #100.

Dominant language
Go
Stars
149
Forks
15
Avg merge
1d 54m
Merged PRs (30d)
53

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from relab/gorums

All issues in relab/gorums

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.