bp / bp/resqpy

Add changelog information to docs

Open
#434 2 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
67
Forks
18
Avg merge
2h 26m
Merged PRs (30d)
1

Description

Many repos keep a changelog. Recommended practices / style are here: https://keepachangelog.com/en/1.0.0/

Suggested actions:

- [ ] Add CHANGELOG.md to repo, in format detailed above
- [ ] Key changes of past few releases populated
- [ ] Include changelog into build documentation (e.g. markdown-to-RST extension [here](https://stackoverflow.com/questions/46278683/include-my-markdown-readme-into-sphinx))

Contributor guide

Open the contributing guide

Research direction

Start by checking the repository's documentation build and release history, then review the Keep a Changelog guidance linked in the issue. Add CHANGELOG.md with key changes from past releases and include it in the built documentation using the referenced Markdown-to-RST approach. Done means the changelog is present, populated, and appears in generated docs.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.