Create template for release notes

[bernars-usa]

Using the upcoming... 1.2.0?... release as inspiration (https://github.com/usds/us-forms-system/releases/tag/untagged-c1ee5d60f627d4ed1e92), I'm putting together a template for writing release notes. I want us to be concise yet descriptive of the problems and solutions included. This format has worked well in the past in my experience.

You'll note I categorized #195 as a bug fix rather than a feature. Happy to discuss that if there's strong objection.

Here's what I've put together:

---

1.2.0 Release

Thank you for using the US Forms System library. For questions about this release, open an issue.

New Features

• Improved library documentation. This includes Getting Started content, conceptual and referential information about building forms, and reorganized content around customizing forms. Outlined in Organize docs in docs folder #86, addressed in [Ready for review] Forms System Documentation #90.
• Moved a sourcemap embedded in styles.css into a separate file. Outlined in Embedded sourcemap in styles.css makes the file big #120, addressed in Move the styles.css sourcemap from inline to an external file #121.
• Improved FormPage unit tests. Addressed in Clean up and dry out the FormPage unit tests #202.

Resolved Security Issues

• Updated node-sass to a recent version. This satisfied the hoek vulnerability CVE-2018-3728, reported by GitHub. Fixed in Update node-sass to remove the node-gyp vuln #213.

Bug Fixes

• Fields that appeared on both active and inactive pages were incorrectly removed from form submission data. Reported in transformForSubmit strips non-empty showPagePerItem pages #140, fixed in Do not filter out properties on inactive pages that also appear on active pages #155.
• CSS styles for fields that are conditionally expanded below other fields using the expandUnder property in the uiSchema object were missing from the US Forms System library. Fixed in Add missing expandable group styles #192.
• In forms without an introduction page, exclude the back button on the first page. After we made the introduction page optional in the US Forms System Starter App (usds/us-forms-system-starter-app@84c7a23), the back button remained on the first page of the form. Reported in Forms without an introduction page can never go back #177, addressed in Don't show back button on first page #195.

---

cc @usds/forms-system

[annekainicUSDS]

@bernars-usa this looks good to me! I wonder if we should also specify if the new release includes breaking changes for users using an earlier version. This particular release doesn't include breaking changes.

Also, is the idea to include this new template for the current release we're trying to get out? #216. FYI, this current release is 1.1.0, not 1.2.0.

[bernars-usa]

I wonder if we should also specify if the new release includes breaking changes for users using an earlier version.

Yes, if the release includes breaking changes, we should clearly document that at the top of the RNs. 👍

Also, is the idea to include this new template for the current release we're trying to get out? #216. FYI, this current release is 1.1.0, not 1.2.0.

Yes, sorry, I meant for the current release we're trying to get out. I think I was quickly incrementing up from the release I was looking at, which was actually the draft release.

[jcmeloni-usds]

Thumbs up - I meant to say that last week but better late than never!

[bernars-usa]

Would it be helpful if I added an actual Markdown template to the repo for this?

[annekainicUSDS]

@bernars-usa Yes I think a markdown template would be super helpful!