parse-community / parse-community/parse-server

Define breaking changes

Open
#8,084 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:docs
Dominant language
JavaScript
Stars
21.4k
Forks
4.8k
Avg merge
7h 45m
Merged PRs (30d)
11

Description

New Feature / Enhancement Checklist
Current Limitation

It is currently not defined what constitutes a breaking change in Parse Platform org.

Feature / Enhancement Description

Add a section to the docs which defines what's considered a breaking change and - as importantly - what is not.

What is a braking change:

  • Changing the name of an API endpoint, method or variable.
  • Changing the http response code of an API response.
  • Changing the behavior of an endpoint or method.
  • Changing the code part of a Parse.Error.

What is not a braking change:

  • Changing of unexposed (internal) Parse Server methods and variables.
  • Changing the message part of a Parse.Error.
Example Use Case

It is unclear whether changing the "message" part of a Parse.Error is considered a breaking change or not. Developers may sometimes use the error text to get detect the exact error because the "code" part of a Parse.Error may be ambiguous.

Alternatives / Workarounds

n/a

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

No documentation file is named; start by locating the Parse Platform documentation section covering API behavior and Parse.Error responses. Add a definition of breaking and non-breaking changes that resolves the error-message example and covers the listed cases; the issue is done when the policy is documented clearly.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.