-
Notifications
You must be signed in to change notification settings - Fork 108
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
Use GitHub Discussions for periodic announcements #2589
Conversation
docs/publishing.md
Outdated
web-features uses a GitHub Discussions thread to give notice of breaking changes and other major changes to interested web-features consumers. | ||
|
||
If you want to receive these announcements, subscribe to the [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/123456789) <!-- TODO: link to the actual discussion thread, after it's created --> announcements thread or to all discussions through the repository's _Watch_ menu. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to add this (or some version of it) to the repo's root-level README.md file too. Something along the lines of "To use web-features, do this ... you can also see releases here ... and follow this GH discussion for breaking and major changes announcements ...".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this to the package README with 8abe101. Since the repo README already links there, do you think that's sufficient?
This came up on the WebDX call today. One suggestion was to add a link to the announcements thread to our release notes boilerplate text. I'll update the Markdown file about this after the call. |
OK, I this is ready now. If I get an approving review, I'll do the task list at the top, update the links, and merge this. |
A couple of weeks ago, it came up on the WebDX call that we should have a dedicated announcements channel for web-features consumers. This is my proposal for doing that.
This PR adds documentation describing a process for publishing project announcements to GitHub Discussions.
If we choose to merge this PR, then we'll need to do the following just before merging:
After merging, we should: