RocketChat / RocketChat/Rocket.Chat

Add a “What’s changed?” guide for Apps‑Engine contributors

Open
#40,009 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: feature
Dominant language
TypeScript
Stars
46.1k
Forks
13.9k
Avg merge
3d 3h
Merged PRs (30d)
130

Description

Hi team

While exploring the Apps Engine and preparing for local development, I noticed that there isn’t a centralized way for contributors to quickly understand what has changed between versions of the Apps Engine API.

At the moment, keeping track of changes requires going through multiple sources such as PRs, release notes, and issues, which can be time-consuming and sometimes unclear.


Current Challenges

  • Changes to the Apps Engine (new methods, deprecations, behavior updates) are spread across PRs and discussions
  • It’s difficult to distinguish breaking changes vs additive changes
  • Contributors often need to manually test or dig through commits to understand what changed

Why this matters

The Apps Engine is continuously evolving, and more developers are building custom apps on top of it.

Without a clear summary of changes:

  • Contributors spend extra time understanding version differences
  • Upgrading existing apps becomes harder and error-prone
  • There is a risk of relying on deprecated or modified APIs

Suggested Improvement

Introduce a dedicated “What’s Changed?” guide for the Apps Engine, for example:

  • A file like WHAT_CHANGED_APPS_ENGINE.md or a dedicated docs section

  • Organized by version (e.g., “Changes since v1.50”)

  • Clearly categorized into:

    • Breaking changes
    • New features
    • Behavior updates

Additionally, this guide could be:

  • Maintained alongside releases
  • Linked from the main Apps Engine README
  • Written in a concise, developer-friendly format

Expected Impact

  • Faster understanding of API changes
  • Easier upgrades for existing apps
  • Improved developer experience for both new and existing contributors

If this aligns with the project direction, I’d be happy to help draft an initial version or propose a structure for this guide

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Apps Engine README and the existing PRs, release notes, and issues that describe API changes. Draft a WHAT_CHANGED_APPS_ENGINE.md guide organized by version, separating breaking changes, new features, and behavior updates, then link it from the Apps Engine README. Done means contributors can use the guide to understand version differences and upgrade impacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.