Skip to content
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

changelog: Document changes since v27.163. #4800

Merged
merged 1 commit into from
Jun 16, 2021

Conversation

chrisbobbe
Copy link
Contributor

No description provided.

@chrisbobbe chrisbobbe requested a review from gnprice June 14, 2021 19:01
@chrisbobbe chrisbobbe force-pushed the pr-post-163-changelog branch from 43b0633 to 325043c Compare June 14, 2021 19:04
@gnprice
Copy link
Member

gnprice commented Jun 15, 2021

Thanks @chrisbobbe !

The most salient thing is that the "Highlights for users" needs to be a lot shorter. More precisely: the release notes we enter for the Play Store and App Store need to be a lot shorter than that; and this spot is where we do the work of drafting those up 🙂

See previous entries for examples. Those have sometimes bumped up against the limits imposed by the Play Store and App Store; I think 500 characters is the limit on at least one of them.

Apart from the platform-imposed hard limits, people just aren't realistically going to read more than a small handful of items here. So the main thing I do in this section is to cut it down to just the few that users are most likely to actually feel are meaningful for them.

I'll also make some specific comments inline.

Copy link
Member

@gnprice gnprice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments below on the "Highlights for users" section.

I'll take a look next at the developer-facing section but not quite as closely, because it's not user-facing and doesn't have tight length constraints.

Comment on lines 46 to 47
* Added a server-compatibility notice for self-hosted orgs running Zulip
Server versions before 2.0.0. (PR #4750)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one definitely doesn't make it into this section -- most users will never see it, and for those that do, the banner is its own announcement 😉

And nobody will see this and think "ah, that's a great feature, I've been wanting something like that", or "oh that bug, so glad they fixed it." If someone's happy about this feature, it'll only be from rather abstractly reasoning through how it will help cause things to get updated.

Comment on lines 61 to 62
* Unclear, little-used "create group PM" option in the compose box removed.
(PR #4777)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't go in this section -- most users probably never noticed that icon, and nobody will be excited it's gone. (Some will be pleased it's gone, from a UI-connoisseur perspective; but from the direct user perspective, it's the removal of an annoyance one hadn't even quite put a finger on.)

Copy link
Member

@gnprice gnprice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And comments on the developer-facing section. Thanks again!

Comment on lines 91 to 99
* Resolved issues (latest to earliest): PR #4794, PR #4707, PR #4789, PR
#4520, #4766, PR #4787, PR #4785, PR #4784, PR #4780, PR #4786, PR #4721,
PR #4779, PR #4778, PR #4334, PR #4727, PR #4574, PR #4737, #4715, PR
#4777, PR #4774, PR #4709, PR #4750, #4765, PR #4730, #4758, PR #4761, PR
#4762, PR #4731, PR #4717, PR #4700, PR #4710, PR #4760, PR #4749, PR
#4736, PR #4667, PR #4755, PR #4753, #4722, PR #4514, PR #4741, #4604, PR
#4728, PR #4739, PR #4732, PR #3955, #3540, #4006, #4323, #4734, #4264, PR
#4716, PR #4711, PR #4634, PR #4699, PR #4697, PR #4703, PR #4680, PR
#4544, PR #4698, PR #4686, PR #4690, PR #4678, PR #4689, #3517, #3395
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the way I've been compiling this "Resolved issues" list is that each item in it really is an issue, i.e. either a bug or a feature request; when I list a PR, it's because we didn't file a GitHub issue for it.

So for example, taking from the top of this list:

It wouldn't be unreasonable to have a list that includes all kinds of changes, even those that aren't issues. Possibly it'd be less work to compile that way -- though I think probably not, as it makes the list quite a bit longer.

Definitely quite reasonable to experiment with different ways of writing these notes.

If we do make this list broader, though, it should have a correspondingly different heading. "Resolved issues and merged PRs"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would the many muted-user PRs all get listed here? The umbrella issue, #4655, is quite near to being resolved but hasn't been yet.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in that situation it'd be OK to say something like "most of #4655".

But also, that is perhaps a hint that it's time to close #4655 as resolved, and file new issues for specific known things that are missing 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in that situation it'd be OK to say something like "most of #4655".

Done in my next revision 🙂

@chrisbobbe chrisbobbe force-pushed the pr-post-163-changelog branch from 325043c to be2cd11 Compare June 16, 2021 15:41
@chrisbobbe
Copy link
Contributor Author

Thanks for the reviews! Revision pushed. Please see a question at #4800 (comment); I've left all the muted-users PRs in the "Resolved issues" list for this revision but it'd be easy to do something else.

@gnprice
Copy link
Member

gnprice commented Jun 16, 2021

Thanks for the revision! Looks good modulo the bit about the muted-users PRs.

@chrisbobbe chrisbobbe force-pushed the pr-post-163-changelog branch from be2cd11 to 6b990db Compare June 16, 2021 21:04
@chrisbobbe
Copy link
Contributor Author

Thanks for the review! Revision pushed.

@gnprice
Copy link
Member

gnprice commented Jun 16, 2021

Thanks! Looks good except for this stray heading at the top, new in this revision:

+## 27.163 (2021-06-04)
+

I'll go ahead and merge after removing that.

@gnprice gnprice force-pushed the pr-post-163-changelog branch from 6b990db to f61f84d Compare June 16, 2021 21:30
@gnprice gnprice merged commit f61f84d into zulip:master Jun 16, 2021
@chrisbobbe
Copy link
Contributor Author

chrisbobbe commented Jun 16, 2021

Thanks! Looks good except for this stray heading at the top, new in this revision:

+## 27.163 (2021-06-04)
+

I'll go ahead and merge after removing that.

Oops, thanks; I added this temporarily so that tools/changelog czo would work, so I could easily get the issue/PR numbers linkified and look through them more easily :)

@chrisbobbe chrisbobbe deleted the pr-post-163-changelog branch November 4, 2021 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants