Consider using towncrier for improving changelogs on this repository

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation, release, tooling

Research direction

Start with the linked Towncrier documentation and the zarr-python example search to understand the proposed changelog workflow. Identify this repository's release and changelog configuration, then define the integration so pull requests can carry small changelog entries and releases produce documented changes; done means the workflow is configured and demonstrated for a release.

Written by the indexing model from the issue text.

Description

infra

Towncrier documentation:

Example usage:

Basically, it requires that small changelog comments are provided alongside PRs, facilitating the documentation of releases.

Dominant language
Python
Stars
14
Forks
19
No merged PRs in 30d

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 ome/ngff-spec

All issues in ome/ngff-spec

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.