newrelic / newrelic/release-toolkit
Body in notes not respecting new line
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 4
- Forks
- 9
- Avg merge
- 6m
- Merged PRs (30d)
- 1
Description
The following Notes content in the unreleased section:
### Note
a note content
more content
### Second note
content
Produces the following:
### Note
a note content more content
### Second note
content
This is because of how the library works, following Vanilla Markdown. We may think if we like the result and leave it as it is or if we want to create a wrapper or something to modify this behavior.
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 file or test is named. Start by reproducing the supplied Notes Markdown and tracing where the release toolkit renders it; determine whether the intended behavior is standard Markdown or preserved line breaks. Done means the behavior is decided and the corresponding rendering change or documentation is covered by an appropriate test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100