Skip to content

Commit c43be5d

Browse files
authored
docs: update templates and readme
2 parents 8548476 + 00e3f1d commit c43be5d

File tree

4 files changed

+57
-44
lines changed

4 files changed

+57
-44
lines changed

.github/ISSUE_TEMPLATE/---1-report-an-issue.md

+6-23
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,15 @@ assignees: ''
99

1010
### New Issue Checklist
1111
<!--
12-
Please check all of the following boxes [x] before submitting your issue.
12+
Check every following box [x] before submitting your issue.
1313
Click the "Preview" tab for better readability.
14-
Thanks for contributing to the Parse Flutter SDK!
14+
Thanks for contributing to Parse Platform!
1515
-->
1616

1717
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/Parse-SDK-Flutter/security/policy).
1818
- [ ] I am not just asking a [question](https://github.com/parse-community/.github/blob/main/SUPPORT.md).
1919
- [ ] I have searched through [existing issues](https://github.com/parse-community/Parse-SDK-Flutter/issues?q=is%3Aissue).
20-
- [ ] I can reproduce the issue with the [latest version of the Parse Flutter SDK](https://github.com/parse-community/Parse-SDK-Flutter/releases). <!-- We don't investigate issues for outdated releases. -->
21-
- [ ] I can reproduce the issue with the [latest version of Parse Server](https://github.com/parse-community/parse-server/releases).
20+
- [ ] I can reproduce the issue with the latest version of [Parse Server](https://github.com/parse-community/parse-server/releases) and the [Parse Flutter SDK](https://github.com/parse-community/Parse-SDK-Flutter/releases). <!-- We don't investigate issues for outdated releases. -->
2221

2322
### Issue Description
2423
<!-- What is the specific issue? -->
@@ -27,36 +26,20 @@ assignees: ''
2726
<!-- How can someone else reproduce the issue? -->
2827

2928
### Actual Outcome
30-
<!-- What outcome, for example query result, did you get? -->
29+
<!-- What outcome did you get? -->
3130

3231
### Expected Outcome
33-
<!-- What outcome, for example query result, did you expect? -->
32+
<!-- What outcome did you expect? -->
3433

35-
### Pull Request
36-
<!--
37-
Check one of the following boxes [x] if you added a PR and add the link.
38-
If you need any guidance please do ask.
39-
-->
40-
41-
- [ ] 🤩 I submitted a PR with a fix.
42-
43-
### Environment
34+
### Environment
4435
<!-- Be specific with versions, don't use "latest" or semver ranges like "~x.y.z" or "^x.y.z". -->
4536

4637
Parse Flutter SDK
4738
- SDK version: `FILL_THIS_OUT`
48-
- Operating system: `FILL_THIS_OUT`
4939
- Operating system version: `FILL_THIS_OUT`
5040

5141
Server
5242
- Parse Server version: `FILL_THIS_OUT`
53-
- Operating system: `FILL_THIS_OUT`
54-
- Local or remote host (AWS, Azure, Google Cloud, Heroku, Digital Ocean, etc): `FILL_THIS_OUT`
55-
56-
Database
57-
- System (MongoDB or Postgres): `FILL_THIS_OUT`
58-
- Database version: `FILL_THIS_OUT`
59-
- Local or remote host (MongoDB Atlas, mLab, AWS, Azure, Google Cloud, etc): `FILL_THIS_OUT`
6043

6144
### Logs
6245
<!-- Include relevant logs here. -->

.github/ISSUE_TEMPLATE/---2-feature-request.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ assignees: ''
99

1010
### New Feature / Enhancement Checklist
1111
<!--
12-
Check all of the following boxes [x] before submitting your issue.
12+
Check every following box [x] before submitting your issue.
1313
Click the "Preview" tab for better readability.
14-
Thanks for contributing to the Parse Android SDK!
14+
Thanks for contributing to Parse Platform!
1515
-->
1616

1717
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/Parse-SDK-Flutter/security/policy).
@@ -29,6 +29,3 @@ assignees: ''
2929

3030
### Alternatives / Workarounds
3131
<!-- Which alternatives or workarounds exist currently? -->
32-
33-
### 3rd Party References
34-
<!-- Have you seen a similar functionality provided somewhere else? -->

.github/pull_request_template.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### New Pull Request Checklist
2+
<!--
3+
Please check the following boxes [x] before submitting your issue.
4+
Click the "Preview" tab for better readability.
5+
Thanks for contributing to Parse Server!
6+
-->
7+
8+
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/Parse-SDK-Flutter/security/policy).
9+
- [ ] I am creating this PR in reference to an [issue](https://github.com/parse-community/Parse-SDK-Flutter/issues?q=is%3Aissue).
10+
11+
### Issue Description
12+
<!-- Add a brief description of the issue this PR solves. -->
13+
14+
Related issue: #`FILL_THIS_OUT`
15+
16+
### Approach
17+
<!-- Add a description of the approach in this PR. -->
18+
19+
### TODOs before merging
20+
<!--
21+
Add TODOs that need to be completed before merging this PR.
22+
Delete TODOs that do not apply to this PR.
23+
-->
24+
25+
- [ ] Add tests
26+
- [ ] Add changes to documentation (guides, repository pages, in-code descriptions)
27+
- [ ] A changelog entry

README.md

+22-16
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
1-
<p align="center">
2-
<img alt="Parse Logo" src="https://parseplatform.org/img/logo.svg" width="500">
3-
</a>
4-
</p>
1+
# Parse SDK for Flutter / Dart
52

6-
---
3+
[![Build Status](https://app.travis-ci.com/parse-community/Parse-SDK-Flutter.svg?branch=master)](https://app.travis-ci.com/parse-community/Parse-SDK-Flutter)
4+
5+
[![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
6+
[![Sponsors on Open Collective](https://opencollective.com/parse-server/sponsors/badge.svg)][open-collective-link]
7+
[![License](https://img.shields.io/badge/license-BSD-lightgrey.svg)](https://github.com/parse-community/Parse-SDK-Android/blob/master/LICENSE)
8+
[![Forum](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/parse-server)
9+
[![Twitter Follow](https://img.shields.io/twitter/follow/ParsePlatform.svg?label=Follow%20us%20on%20Twitter&style=social)](https://twitter.com/intent/follow?screen_name=ParsePlatform)
710

8-
This repository contains packages that allow communication with a Parse Server,
9-
(https://parseplatform.org) either hosted on your own server or another,
10-
like (http://Back4App.com).
11+
---
1112

12-
This is a work in progress and we are consistently updating it. Please let us know if you think anything needs changing/adding, and more than ever, please do join in on this project. (Even if it is just to improve our documentation)
13+
A library that gives you access to the powerful Parse Server backend from your Flutter app. For more information about Parse and its features, see [the website](https://parseplatform.org/), [getting started][guide], and [blog](https://blog.parseplatform.org/).
1314

1415
## Packages
1516

16-
These are the available packages in this repository.
17+
These packages are available in this repository:
18+
19+
| Package | Pub | Description |
20+
|------------------------------------------------|------------------------------------------------------------------------------------------|-----------------|
21+
| [parse_server_sdk](./packages/dart) | [![pub package](https://img.shields.io/pub/v/parse_server_sdk.svg)](pub-dart) | Dart package |
22+
| [parse_server_sdk_flutter](./packages/flutter) | [![pub package](https://img.shields.io/pub/v/parse_server_sdk_flutter.svg)](pub-flutter) | Flutter package |
1723

18-
| Plugin | Pub | explanation|
19-
|--------|-----|------------|
20-
| [parse_server_sdk](./packages/dart) | [![pub package](https://img.shields.io/pub/v/parse_server_sdk.svg)](https://pub.dev/packages/parse_server_sdk) | a dart package that lets you communicate with the parse server |
21-
| [parse_server_sdk_flutter](./packages/flutter) | [![pub package](https://img.shields.io/pub/v/parse_server_sdk_flutter.svg)](https://pub.dev/packages/parse_server_sdk_flutter) | a flutter package that lets you communicate with the parse server |
24+
## Author
25+
This project was originally authored by Phill Wiggins and since transferred to Parse Platform.
2226

23-
### Author:-
24-
This project was authored by Phill Wiggins. You can contact me at [email protected]
27+
[guide]: http://docs.parseplatform.org/android/guide/
28+
[open-collective-link]: https://opencollective.com/parse-server
29+
[pub-dart]: https://pub.dev/packages/parse_server_sdk
30+
[pub-flutter]: https://pub.dev/packages/parse_server_sdk_flutter

0 commit comments

Comments
 (0)