scala / scala/make-release-notes
Generated Markdown files should have comment that describes which script generated it
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 82
- Forks
- 79
- PR merge metrics
- No merged PRs in 30d
Description
Given the fact that we generate those files in this project and then use it somewhere else (e.g. in scala-lang) it would be good to include a comment in generated Markdown file that points back at script that generated it.
It would vastly help to understand where given files are coming from when analyzing history of previous releases.
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
Locate the script that generates the Markdown release-note files and inspect a generated output. Add a comment that points back to the generating script, then regenerate or inspect the affected files to confirm the provenance comment is present and useful when reviewing release history.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100