Create CHANGELOG.md

Open Beginner friendly
#44 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Start by reading CONTRIBUTING.md and the Keep a Changelog format linked in the issue. Create CHANGELOG.md and review CONTRIBUTING.md for development setup, tests, linting, code style, and contribution steps. Done means the changelog covers all releases and the contributor documentation covers the stated development process.

Written by the indexing model from the issue text.

Description

Add standard project documentation for contributors and release tracking.

Tasks

  • Create CHANGELOG.md following Keep a Changelog format (https://keepachangelog.com/)
  • Review CONTRIBUTING.md to confirm it contains all details for running tests, linting, and code style.

Acceptance Criteria

  • Confirm CONTRIBUTING.md covers development setup and contribution process
  • CHANGELOG.md documents all releases
Dominant language
Go
Stars
66
Forks
27
Avg merge
14d 3h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

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 containers/tar-diff

All issues in containers/tar-diff

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.