From 0cca354a329eeea1b21ea5f02f3294247078f3e8 Mon Sep 17 00:00:00 2001 From: Phil Sturgeon Date: Thu, 30 Nov 2017 12:49:10 -0500 Subject: [PATCH 1/2] Hunting through travis.yml isnt ideal --- CONTRIBUTING.md | 14 ++++++++++++++ README.md | 4 +++- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..59ab549 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +PRs are always welcome, and we'll be happy to merge them if the test suite passes. + +To run the entire test suite would take a long time, so we've broken it down into various groups: + +``` shell +TEST_TARGET=lint make test +TEST_TARGET=unit make test +TEST_TARGET=e2e make test +TEST_TARGET=cov make test +``` + +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. + +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. diff --git a/README.md b/README.md index 4e0b4f2..cbe9e28 100644 --- a/README.md +++ b/README.md @@ -91,10 +91,12 @@ API-Flow is one of the main components of [Console.REST](https://github.com/luck ## Contributing -PRs are welcomed! +Read [CONTRIBUTING.md](CONTRIBUTING.md) for more tips on testing and contributing. + 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. ## Documentation + 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) ## License From 4cd8c6a5b55412253031d080a53d22babecc713c Mon Sep 17 00:00:00 2001 From: Phil Sturgeon Date: Tue, 5 Dec 2017 13:16:40 -0500 Subject: [PATCH 2/2] Local links work well for GitHub READMEs A few forks were updating these links and causing conflicts, so lets just use local links :D --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cbe9e28..a71bca8 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ Our sole requirement is that organizations that want to extend API-Flow to suppo ## Documentation -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) +You can find more information about the internal structure of API-Flow in [src](src). We've also created a set of templates to help speed up the extension process: [loader](src/loaders/template/v1.0), [parser](src/parsers/template/v1.0/), and [environment](src/environments/template) ## License