Skip to content

Commit 759346b

Browse files
Add conventions
1 parent 6d62b93 commit 759346b

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,31 @@ A few resources to get you started if this is your first Flutter project:
1414
For help getting started with Flutter development, view the
1515
[online documentation](https://docs.flutter.dev/), which offers tutorials,
1616
samples, guidance on mobile development, and a full API reference.
17+
18+
## Conventions
19+
20+
### Code Style
21+
22+
We follow the [Effective Dart code style](https://dart.dev/effective-dart/style).
23+
24+
Code should be formatted using `dart format` ([docs](https://dart.dev/tools/dart-format)).
25+
26+
### Commits, Branches and Pull Requests
27+
28+
Branch names should be written using kebab-case and have the following schema:
29+
30+
```
31+
<issue_key>-your-branch-name
32+
33+
1234-commit-message-documentation
34+
```
35+
36+
Commit messages and PR names should have the following schema:
37+
```
38+
<issue_key>: Your commit message
39+
40+
1234: Add commit message documentation
41+
```
42+
43+
See [this guide](https://github.com/erlang/otp/wiki/Writing-good-commit-messages) for a general reference on how to
44+
write good commit messages.

0 commit comments

Comments
 (0)