facebook / facebook/relay

Releases: Curate and summarize changes for users?

Open
#3,881 1 comment 4 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
19k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

Firstly, thank you for the project!

I think it'd be helpful if maintainers helped recap and highlight what would be important to users.

Recent updates have felt like git activity snapshots: [v13.0.3](https://github.com/facebook/relay/releases/tag/v13.0.3), [v13.2.0](https://github.com/facebook/relay/releases/tag/v13.2.0). While reassuring to see on an open source project and the hard work is laudable, they're not tailored (yet) toward the library user. I think that's what changelogs should do.

I believe right now releases may be automated some how. e.g. releases also link to a "Full Changelog". However it's not a changelog in any ordinary sense: [`v13.1.1...v13.2.0`](https://github.com/facebook/relay/compare/v13.1.1...v13.2.0).

I can't understand what maintainers find important to the user, if not that, what's happening "big picture" in the project from a development standpoint.

By contrast, here is https://github.com/facebook/react's [`CHANGELOG.md`](https://github.com/facebook/react/blob/v18.0.0/CHANGELOG.md)

![image](https://user-images.githubusercontent.com/26336/163871367-47bdbdd2-b18e-4984-860a-d4c8cb511c71.png)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked v13.0.3 and v13.2.0 release pages, their Full Changelog comparisons, and React's CHANGELOG.md example. The issue does not identify a file, release workflow, or agreed format; a completed effort would need a defined user-facing release-summary approach and maintainer agreement.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.