You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-1Lines changed: 21 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
3
3
## Table of Contents <!-- omit in toc -->
4
4
-[Contributing](#contributing)
5
+
-[Templates](#templates)
5
6
-[Why Contributing?](#why-contributing)
6
7
-[Environment Setup](#environment-setup)
7
8
-[Recommended Tools](#recommended-tools)
@@ -20,6 +21,7 @@
20
21
-[Parse Error](#parse-error)
21
22
-[Parse Server Configuration](#parse-server-configuration)
22
23
-[Pull Request](#pull-request)
24
+
-[Commit Message](#commit-message)
23
25
-[Breaking Change](#breaking-change)
24
26
-[Merging](#merging)
25
27
-[Breaking Change](#breaking-change-1)
@@ -48,6 +50,22 @@ When you are ready to code, you can find more information about opening a pull r
48
50
49
51
Whether this is your first contribution or you are already an experienced contributor, the Parse Community has your back – don't hesitate to ask for help!
50
52
53
+
### Issue vs. Pull Request
54
+
55
+
An issue is required to be linked in every pull request. We understand that no-one likes to create an issue for something that appears to be a simple pull request, but here is why this is beneficial for everyone:
56
+
57
+
- An issue get more visibility than a pull request as issues can be pinned, receive bounties and it is primarily the issue list that people browse through rather than the more technical pull request list. Visibility is a key aspect so others can weigh in on issues and contribute their opinion.
58
+
- The discussion in the issue is different from the discussion in the pull request. The issue discussion is focused on the issue and how to address it, whereas the discussion in the pull request is focused on a specific implemention. An issue may even have multiple pull requests because either the issue requires multiple implementations or multiple pull requests are opened to compare and test different approaches to later decide for one.
59
+
- High-level conceptual discussions about the issue should be still available, even if a pull request is closed because its appraoch was discarded. If these discussions are in the pull request instead, they can easily become fragmented over multiple pull requests and issues, which can make it very hard to make sense of all aspects of an issue.
60
+
61
+
### Templates
62
+
63
+
You are required to use and completely fill out the templates for new issues and pull requests. We understand that no-one enjoys filling out forms, but here is why this is beneficial for everyone:
64
+
65
+
- It may take you 30 seconds longer, but will save even more time for everyone else trying to understand your issue.
66
+
- It helps to fix issues and merge pull requests faster as reviewers spend less time trying to understand your issue.
67
+
- It makes investigations easier when others try to understand your issue and code changes made even years later.
68
+
51
69
## Why Contributing?
52
70
53
71
Buy cheap, buy twice. What? No, this is not the Economics 101 class, but the same is true for contributing.
@@ -305,6 +323,8 @@ Introducing new [Parse Server configuration][config] parameters requires the fol
305
323
306
324
## Pull Request
307
325
326
+
### Commit Message
327
+
308
328
For release automation, the title of pull requests needs to be written in a defined syntax. We loosely follow the [Conventional Commits](https://www.conventionalcommits.org) specification, which defines this syntax:
309
329
310
330
```
@@ -393,7 +413,7 @@ If the commit reverts a previous commit, use the prefix `revert:`, followed by t
393
413
394
414
### Major Release / Long-Term-Support
395
415
396
-
Long-Term-Support (LTS) is provided for the previous Parse Server major version. For example, Parse Server 4.x will receive security updates until Parse Server 5.x is superseded by Parse Server 6.x and becomes the new LTS version. While the current major version is published on branch `release`, a LTS version is published on branch `release-#.x.x`, for example `release-4.x.x` for the Parse Server 4.x LTS branch.
416
+
While the current major version is published on branch `release`, a Long-Term-Support (LTS) version is published on branch `release-#.x.x`, for example `release-4.x.x` for the Parse Server 4.x LTS branch.
-[Customizing your GraphQL Schema](#customizing-your-graphql-schema)
91
93
-[Learning more](#learning-more)
92
-
-[Upgrading to 3.0.0](#upgrading-to-300)
93
-
-[Want to ride the bleeding edge?](#want-to-ride-the-bleeding-edge)
94
+
-[Upgrading to Parse Server 3.0](#upgrading-to-parse-server-30)
94
95
-[Contributing](#contributing)
95
96
-[Contributors](#contributors)
96
97
-[Sponsors](#sponsors)
97
98
-[Backers](#backers)
98
99
100
+
# Flavors & Branches
101
+
102
+
Parse Server is available in different flavors on different branches:
103
+
104
+
- The main branches are [release][log_release], [beta][log_beta] and [alpha][log_alpha]. See the [changelog overview](CHANGELOG.md) for details.
105
+
- The long-term-support (LTS) branches are named `release-<version>.x.x`, for example `release-4.x.x`. LTS branches do not have pre-release branches.
106
+
107
+
## Long Term Support
108
+
109
+
Long-Term-Support (LTS) is provided for the previous Parse Server major version. For example, Parse Server 4.x will receive security updates until Parse Server 5.x is superseded by Parse Server 6.x and becomes the new LTS version. While the current major version is published on branch `release`, a LTS version is published on branch `release-#.x.x`, for example `release-4.x.x` for the Parse Server 4.x LTS branch.
110
+
111
+
⚠️ LTS versions are provided to help you transition as soon as possible to the current major version. While we aim to fix security vulnerabilities in the LTS version, our main focus is on developing the current major version and preparing the next major release. Therefore we may leave certain vulnerabilities up to the community to fix. Search for [pull requests with the specific LTS base branch](https://github.com/parse-community/parse-server/pulls?q=is%3Aopen+is%3Apr+base%3Arelease-4.x.x) to see the current open vulnerabilities for that LTS branch.
112
+
99
113
# Getting Started
100
114
101
115
The fastest and easiest way to get started is to run MongoDB and Parse Server locally.
@@ -1104,37 +1118,15 @@ You also have a very powerful tool inside your GraphQL Playground. Please look a
1104
1118
1105
1119
Additionally, the [GraphQL Learn Section](https://graphql.org/learn/) is a very good source to learn more about the power of the GraphQL language.
1106
1120
1107
-
# Upgrading to 3.0.0
1108
-
1109
-
Starting 3.0.0, parse-server uses the JS SDK version 2.0.
1110
-
In short, parse SDK v2.0 removes the backbone style callbacks as well as the Parse.Promise object in favor of native promises.
1111
-
All the Cloud Code interfaces also have been updated to reflect those changes, and all backbone style response objects are removed and replaced by Promise style resolution.
1112
-
1113
-
We have written up a [migration guide](3.0.0.md), hoping this will help you transition to the next major release.
1114
-
1115
-
# Want to ride the bleeding edge?
1121
+
# Upgrading to Parse Server 3.0
1116
1122
1117
-
It is recommend to use builds deployed npm for many reasons, but if you want to use
1118
-
the latest not-yet-released version of parse-server, you can do so by depending
Starting Parse Server 3.0, Parse Server uses the Parse JavaScript SDK 2.0. In short, the Parse JavaScript SDK 2.0 removes the backbone style callbacks as well as the `Parse.Promise` object in favor of native promises. All the Cloud Code interfaces also have been updated to reflect those changes, and all backbone style response objects are removed and replaced by promise style resolution.
1132
1124
1133
-
And don't forget, if you plan to deploy it remotely, you should run `npm install` with the `--save` option.
1125
+
We have written up a [migration guide](3.0.0.md) to help you transition to the next major release.
1134
1126
1135
1127
# Contributing
1136
1128
1137
-
We really want Parse to be yours, to see it grow and thrive in the open source community. Please see the [Contributing to Parse Server guide](CONTRIBUTING.md).
1129
+
Please see the [Contributing Guide](CONTRIBUTING.md).
1138
1130
1139
1131
# Contributors
1140
1132
@@ -1190,3 +1182,6 @@ As of April 5, 2017, Parse, LLC has transferred this code to the parse-community
0 commit comments