Skip to content

Commit 03323ce

Browse files
committed
📖 Add README sections about dartfmt, analyzer, test and CI
1 parent d1cba96 commit 03323ce

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,39 @@
1-
# `dartsidedev/algorithms`
1+
# [`dartsidedev/algorithms`](https://github.com/dartsidedev/algorithms)
22

33
**Solutions to various algorithms using the Dart programming language.**
44

5-
> by Vince Varga
5+
> by [Vince Varga](https://github.com/vargavince91)
66
77
## What to expect
88

9-
I decided to implement various algorithms, solve programming challenges and problems, all the while I'm learnign to write idiomatic (?) [Dart](http://dart.dev) code.
9+
I decided to implement various algorithms, solve programming challenges and problems, all the while I'm learnign to write idiomatic [Dart](http://dart.dev) code and get better at testing in Dart. I used to test everything thoroughly in JavaScript, but didn't really learn the testing libraries in Dart yet.
10+
11+
Based on the things I'm learning here, I write a Dart package for all things data structures and common algorithms. Go to [`dartsidedev/pop_dart`](https://github.com/dartsidedev/pop_dart) to figure out where we stand on library front today.
12+
13+
## Development
14+
15+
### Formatting
16+
17+
This project uses [`dartfmt`](https://dart.dev/tools/dartfmt) to idiomatically format Dart source code.
18+
19+
Run `dartfmt -w .` before committing to make sure every Dart file is properly formatted.
20+
21+
### Static analysis and linter
22+
23+
We use [`dartanalyzer`](https://dart.dev/tools/dartanalyzer) to run static analysis and a linter on this project.
24+
25+
```
26+
$ dartanalyzer .
27+
```
28+
29+
This project's [`analysis_options.yaml`](./analysis_options.yaml) file is taken from the [`flutter/flutter`](https://github.com/flutter/flutter/blob/master/analysis_options.yaml) project.
30+
31+
### Tests
32+
33+
Run all tests in the project by executing `pub run test .` command.
34+
35+
### Continuous Integration
36+
37+
We use Travis CI to check our code on every push.
38+
39+
[![Travis CI Build Status](https://travis-ci.com/dartsidedev/algorithms.svg?branch=master)](https://travis-ci.com/dartsidedev/algorithms)

0 commit comments

Comments
 (0)