Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.

Commit 0cca354

Browse files
author
Phil Sturgeon
committed
Hunting through travis.yml isnt ideal
1 parent 24cc71a commit 0cca354

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
PRs are always welcome, and we'll be happy to merge them if the test suite passes.
2+
3+
To run the entire test suite would take a long time, so we've broken it down into various groups:
4+
5+
``` shell
6+
TEST_TARGET=lint make test
7+
TEST_TARGET=unit make test
8+
TEST_TARGET=e2e make test
9+
TEST_TARGET=cov make test
10+
```
11+
12+
All of these will be run by Travis, but you could save the ice caps from melting a little by running at least `unit` and `e2e` before you push.
13+
14+
Our sole requirement is that organizations that want to extend API-Flow to support their format write both a parser and a serializer, and not simply a serializer.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,12 @@ API-Flow is one of the main components of [Console.REST](https://github.com/luck
9191

9292
## Contributing
9393

94-
PRs are welcomed!
94+
Read [CONTRIBUTING.md](CONTRIBUTING.md) for more tips on testing and contributing.
95+
9596
Our sole requirement is that organizations that want to extend API-Flow to support their format write both a parser and a serializer, and not simply a serializer.
9697

9798
## Documentation
99+
98100
You can find more information about the internal structure of API-Flow in [src](https://github.com/luckymarmot/API-Flow/tree/develop/src). We've also created a set of templates to help speed up the extension process: [loader](https://github.com/luckymarmot/API-Flow/tree/develop/src/loaders/template/v1.0), [parser](https://github.com/luckymarmot/API-Flow/tree/develop/src/parsers/template/v1.0/), and [environment](https://github.com/luckymarmot/API-Flow/tree/develop/src/environments/template)
99101

100102
## License

0 commit comments

Comments
 (0)