-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: add v12.2.0 release notes #251
Conversation
Hey @aleclarson, do you intend to keep a {version}.md file for all future versions? |
@MarlonPassos-git Yeah that's the plan. Why do you ask? |
And I was thinking that over time it might get a bit messy having a large number of {version}.md files at the root of the project. This isn’t something I usually see in projects; they typically group them into a documentation folder or something similar. |
Oh I think you misread what I wrote up top. 😄 As you can see, this PR is targeting a |
The next ones to refine are `isRegExp` and below.
Just now, I've refined all of the sections from the beginning until The basic guidelines are:
|
I've done more work on this today. I'm down to line 782! |
🥳 |
The release notes for v12.2.0, a work in progress. I've created a
release-notes
branch, which this PR targets, so I could open a PR tracking my progress and inviting collaboration. This should help keep the process open and transparent. These release notes will also exist in the GitHub Releases section upon completion.What's needed:
More/better code examples(edit: Now that we link to the docs, this isn't as big of a deal. Just make sure the example previews the core functionality.)chore
commits)Long-term solution
I used this script to generate the initial draft. The generated draft saved a lot of time, but I've since edited it quite a bit. I think there's still room for improvement in that script, so less editing is needed in the future. Specifically, including an example of desired output would help a lot, I think.