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
By participating, you are expected to uphold international human rights and fundamental freedoms!
16
-
To put it simply, be kind to each other.
19
+
To put it simply, be kind to each other.
17
20
18
21
## Get started
22
+
19
23
- Get the [Dart tools](https://dart.dev/tools)
20
24
- Clone the repository: ```git clone [email protected]:dartclub/turf_dart.git```
21
25
- Navigate to project's folder in terminal & get its dependencies: ```dart pub get```
22
26
- Go through [Implementation Process](#implementation-process)
23
27
- Import the library in your code and use it. For example:
28
+
24
29
```dart
25
30
import 'package:turf/helpers.dart';
26
31
import 'package:turf/src/line_segment.dart';
@@ -58,7 +63,8 @@ var total = segmentReduce<int>(poly, (previousValue,
58
63
```
59
64
60
65
## Structure of modules
61
-
```
66
+
67
+
```text
62
68
TURF_DART/lib/<MODULE NAME>.dart // public facing API, exports the implementation
63
69
│ │
64
70
│ └───src/<MODULE NAME>.dart // the implementation
@@ -67,7 +73,9 @@ TURF_DART/lib/<MODULE NAME>.dart // public facing API, exports the implementatio
67
73
│
68
74
└───test/components/<MODULE NAME>_test.dart // all the related tests
69
75
```
76
+
70
77
## Implementation process
78
+
71
79
- Check the Backlog/Issues for similar issues
72
80
- Create a new branch _feature-_ from _main_
73
81
- Create a _draft Pull request_, mention in it the associated issues
@@ -80,16 +88,17 @@ TURF_DART/lib/<MODULE NAME>.dart // public facing API, exports the implementatio
80
88
- run the benchmark: ```dart pub run benchmark```
81
89
- Commit
82
90
- Convert to real Pull request _ready for review_
83
-
- Code review / mention a reviewer from [contributors list](https://github.com/dartclub/turf_dart/graphs/contributors)
84
-
91
+
- Code review / mention a reviewer from [contributors list](https://github.com/dartclub/turf_dart/graphs/contributors)
85
92
86
93
## Documentation
94
+
87
95
We follow [Effective Dart](https://dart.dev/guides/language/effective-dart/documentation) guidelines for documentation.
88
96
89
97
After going through the [Implementation Process](#implementation-process), please mention the made changes in [README.md](https://github.com/dartclub/turf_dart/blob/main/README.md)
90
98
91
99
In order to add to this very documentation, please develop CONTRIBUTING.md in [documentation branch](https://github.com/dartclub/turf_dart/tree/documentation)
92
100
93
101
## GeoJSON Object Model
102
+
94
103
If you have not read our [README.md](https://github.com/dartclub/turf_dart/blob/main/README.md) this diagram will give you a lot of information. Please consider looking our [notable design decisions](https://github.com/dartclub/turf_dart/blob/main/README.md#notable-design-decisions).
0 commit comments