mapbox / mapbox/github-release-tools
Generalize changelog-draft
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 16
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
This quick-and-dirty sorting into sections is currently tied to mapbox-gl-js's labels/sections:
https://github.com/mapbox/github-release-tools/blob/8d88e10b6fedf3f34f8d3929287148088e65709c/bin/changelog-draft#L72-L78
https://github.com/mapbox/github-release-tools/blob/8d88e10b6fedf3f34f8d3929287148088e65709c/bin/changelog-draft#L92-L103
It should be made configurable so it can easily used for other repos
Contributor guide
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
Start in bin/changelog-draft at the linked sections around lines 72-78 and 92-103, and inspect how labels and sections are currently selected. Determine a configuration approach that works for repositories beyond mapbox-gl-js, then verify the generated changelog still sorts entries into the configured sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- release, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100