QuantEcon / QuantEcon/QuantEcon.py

Improvements to auto-generated CHANGELOG.md

Open
#404 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
2.4k
Forks
2.3k
Avg merge
3d 3h
Merged PRs (30d)
3

Description

Suggested improvement to CHANGELOG.md file generator from @oyamad

This is an issue of the software, but it would be nice if the names of all the collaborators (committers) show up as contributors of a PR; see for example

https://github.com/QuantEcon/QuantEcon.py/pull/403/files#diff-4ac32a78649ca5bdd8e0ba38b7006a1eR9

where among the four committers, only the name of the person who opens the PR appears.

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.

Research direction

Start by locating the generator for CHANGELOG.md and compare its output with the referenced pull request #403. Confirm how the four committers are represented, then make the generated changelog list all collaborators as contributors and verify the resulting output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.