Skip to content

Commit bbccfb3

Browse files
committed
format markdown
1 parent dcbd0e5 commit bbccfb3

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@
3636
- Documentation: improves pub.dev scores, raised documentation coverage, fixed typos
3737
- Return type fixes for the the meta extensions
3838

39-
4039
## 0.0.5
4140

42-
- Implements *all* meta functions and`lineSegment`
41+
- Implements *all* meta functions and`lineSegment`
4342
- Adds a lot of documentation
4443
- Several bug and type fixes
4544

CONTRIBUTING.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,29 @@
33
Welcome and thank you for deciding to contribute to the project!
44

55
Here is how cooperation works perfectly at [Turf Dart](https://github.com/dartclub/turf_dart)
6+
67
#### Table of Contents
7-
- [Code of Conduct](#code-of-conduct)
8-
- [Get started](#get-started)
9-
- [Structure of modules](#structure-of-modules)
10-
- [Implementation Process](#implementation-process)
11-
- [Documentation](#documentation)
12-
- [GeoJSON object model](#GeoJSON-object-model)
8+
9+
- [Code of Conduct](#code-of-conduct)
10+
- [Get started](#get-started)
11+
- [Structure of modules](#structure-of-modules)
12+
- [Implementation Process](#implementation-process)
13+
- [Documentation](#documentation)
14+
- [GeoJSON object model](#GeoJSON-object-model)
1315

1416
## Code of conduct
17+
1518
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.
1720

1821
## Get started
22+
1923
- Get the [Dart tools](https://dart.dev/tools)
2024
- Clone the repository: ```git clone [email protected]:dartclub/turf_dart.git```
2125
- Navigate to project's folder in terminal & get its dependencies: ```dart pub get```
2226
- Go through [Implementation Process](#implementation-process)
2327
- Import the library in your code and use it. For example:
28+
2429
```dart
2530
import 'package:turf/helpers.dart';
2631
import 'package:turf/src/line_segment.dart';
@@ -58,7 +63,8 @@ var total = segmentReduce<int>(poly, (previousValue,
5863
```
5964

6065
## Structure of modules
61-
```
66+
67+
```text
6268
TURF_DART/lib/<MODULE NAME>.dart // public facing API, exports the implementation
6369
│ │
6470
│ └───src/<MODULE NAME>.dart // the implementation
@@ -67,7 +73,9 @@ TURF_DART/lib/<MODULE NAME>.dart // public facing API, exports the implementatio
6773
6874
└───test/components/<MODULE NAME>_test.dart // all the related tests
6975
```
76+
7077
## Implementation process
78+
7179
- Check the Backlog/Issues for similar issues
7280
- Create a new branch _feature-_ from _main_
7381
- 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
8088
- run the benchmark: ```dart pub run benchmark```
8189
- Commit
8290
- 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)
8592

8693
## Documentation
94+
8795
We follow [Effective Dart](https://dart.dev/guides/language/effective-dart/documentation) guidelines for documentation.
8896

8997
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)
9098

9199
In order to add to this very documentation, please develop CONTRIBUTING.md in [documentation branch](https://github.com/dartclub/turf_dart/tree/documentation)
92100

93101
## GeoJSON Object Model
102+
94103
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).
95104
![polymorphism](https://user-images.githubusercontent.com/10634693/159876354-f9da2f37-02b3-4546-b32a-c0f82c372272.png)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# turf.dart
22

3-
ℹ️ Looking for maintainers as a work student position in Germany: Write an email to [email protected] ℹ️
3+
ℹ️ Looking for maintainers as a work student position in Germany: Write an email to [[email protected]](mailto:[email protected]) ℹ️
44

55
[![pub package](https://img.shields.io/pub/v/turf.svg)](https://pub.dev/packages/turf)
66

0 commit comments

Comments
 (0)