Skip to content

Commit b0ae1db

Browse files
committed
more
1 parent 6986a05 commit b0ae1db

File tree

4 files changed

+17
-12
lines changed

4 files changed

+17
-12
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
## Changes
22

3-
_Please list issues fixed by this PR here, using format "Fixes #the-issue-number"._
3+
Fixes #the-issue-number-here
44

5-
## Checklist
5+
## Procedure and Checklist
66

7-
- [ ] An issue to be fixed by this PR is listed above.
8-
- [ ] New tests are added to ensure new features are working. Please refer to [this page](https://cjycode.com/flutter_rust_bridge/guides/contributing/tip) to see how to add a test.
9-
- [ ] `./frb_internal precommit --mode slow` (or `fast`) is run (it internal runs code generator, does auto formatting, etc).
10-
- [ ] If this PR adds/changes features, documentations (in the `./website` folder) are updated.
11-
- [ ] CI is passing. Please refer to [this page](https://cjycode.com/flutter_rust_bridge/guides/contributing/tip) to see how to solve a failed CI.
7+
In order to quickly iterate and avoid slowing down development pace by making CI pass, only the following simplified steps are needed, and I (fzyzcjy) will handle the rest of CI / moving the tests currently (will have more automation in the future).
128

13-
## Remark for PR creator
9+
- [ ] Implement the feature / fix the bug.
10+
- [ ] Add tests in `frb_example/dart_minimal`.
11+
- [ ] Make `dart_minimal`'s CI green.
1412

15-
- `./frb_internal --help` shows utilities for development.
16-
- If fzyzcjy does not reply for a few days, maybe he just did not see it, so please ping him.
13+
Utility commands
14+
- Run codegen: `cargo run --manifest-path /path/to/flutter_rust_bridge/frb_codegen/Cargo.toml -- generate`
15+
* Run tests: `./frb_internal test-dart-native --package frb_example/dart_minimal`

website/docs/guides/contributing/overview.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Overview
22

3+
:::tip
4+
It is not a prerequisite to go through these documents before making a PR,
5+
and these are here for completeness and cases when one needs to dig deeper into the internals.
6+
In addition, feel free to ping me (@fzyzcjy) to ask for hints and suggestions on implementation.
7+
:::
8+
39
## Prelude
410

511
Firstly, welcome, and thanks for your contributions!

website/docs/guides/contributing/tip.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Tips and procedures
1+
# Misc Tips
22

33
## How to add a test
44

website/sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,6 @@ const sidebars = {
452452
},
453453
items: [
454454
'guides/contributing/overview',
455-
'guides/contributing/tip',
456455
{
457456
type: 'category',
458457
label: 'Submodules',
@@ -470,6 +469,7 @@ const sidebars = {
470469
'guides/contributing/submodules/manual-test',
471470
],
472471
},
472+
'guides/contributing/tip',
473473
],
474474
},
475475
],

0 commit comments

Comments
 (0)