parse-community / parse-community/parse-server
Define breaking changes
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 21.4k
- Forks
- 4.8k
- Avg merge
- 7h 45m
- Merged PRs (30d)
- 11
Description
New Feature / Enhancement Checklist
- I am not disclosing a vulnerability.
- I am not just asking a question.
- I have searched through existing issues.
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
codepart of aParse.Error.
What is not a braking change:
- Changing of unexposed (internal) Parse Server methods and variables.
- Changing the
messagepart of aParse.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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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