CONTRIBUTING.md exists with branch flow, pre-commit, and release procedure

Open Beginner friendly
#78 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
haskell
Domain
developer-experience, documentation, release

Research direction

Start by reading README.md, the repository setup and test instructions, and issue 1.0.0.3 #75 to confirm the final tag-driven release trigger. Create CONTRIBUTING.md at the repository root using the nayafia/contributing-template framework, then add the README.md link; done means all listed sections and acceptance criteria are covered.

Written by the indexing model from the issue text.

Description

enhancement

Summary

Create CONTRIBUTING.md covering: trunk-based branching, how to install pre-commit hooks, how to run tests, and the release procedure (tag → workflow publishes).

Motivation

External contributors currently have no single document explaining how the project works. The release-procedure section also serves as the implementation memo for the new tag-driven flow shipped in 1.0.0.3.

Scope

  • Use the nayafia/contributing-template framework.
  • Sections: project overview, dev setup, pre-commit install, running tests, branching expectations (no long-lived branches), release procedure.
  • README links to it.

Acceptance criteria

  • CONTRIBUTING.md present at repo root.
  • Covers: clone/setup, pre-commit install, test running, branching expectations, release procedure (referencing whichever trigger 1.0.0.3 #75 settled on).
  • README.md links to CONTRIBUTING.md.

Additional context

Use the contributing skill. Depends on milestone 1.0.0.3 closing so the release procedure can reference the final trigger.

Dominant language
Haskell
Stars
1
Forks
2
Avg merge
3h 38m
Merged PRs (30d)
19

Contributor guide

No contributing guide indexed for this repository

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 alunduil/network-arbitrary

All issues in alunduil/network-arbitrary

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.