matthewwithanm / matthewwithanm/python-markdownify
A change log would be helpful
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 203
- PR merge metrics
- No merged PRs in 30d
Description
I have a unit test failing in my project after upgrading from markdownify v1.1.0 to 1.2.2 due to a change in what newlines are produced.
Presumably, the change is on purpose and for a good reason, but it would be really helpful if there were a change log or history file so I could easily see what kinds of things changed in what versions.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Review the changes between markdownify v1.1.0 and v1.2.2, then determine where a changelog or history file belongs; it is done when users can identify notable changes by version, including the newline behavior change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100