Add a CHANGELOG.md

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

@DhavalGojiya is already working on this.

Since Sep 24, 2026.

  • #374 by @DhavalGojiya — open

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation, release

Research direction

Start by reviewing the existing changelog section in the Sphinx documentation and the project's PyPI release history. Create CHANGELOG.md in Keep a Changelog format covering releases 1.0 through 1.9.1, marking 1.7.0, 1.8.0, and 1.9.3 as yanked, and place post-1.9.1 changes under Unreleased. Done means the Sphinx changelog section links to the new file and the 2.0.0 planning entry is included.

Written by the indexing model from the issue text.

Description

Proposal

Add a CHANGELOG.md in the Keep a Changelog format, replacing the changelog section in the Sphinx docs with a link to it.

Scope

  • All releases from 1.0 to 1.9.1, dated by PyPI upload time
  • 1.7.0, 1.8.0 and 1.9.3 marked [YANKED]: 1.9.3 is yanked on PyPI, and the old docs say 1.7.0 and 1.8.0 were removed from PyPI
  • Everything merged since 1.9.1 under Unreleased, planned for 2.0.0
Dominant language
Python
Stars
264
Forks
81
No merged PRs in 30d

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No 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 django-commons/drf-haystack

All issues in django-commons/drf-haystack

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.