From 8f147405d71f36997278d958887512da7b690618 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Gw=C3=B3=C5=BAd=C5=BA?= Date: Thu, 8 Jun 2023 13:25:41 +0200 Subject: [PATCH 1/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06261f76..651893a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,13 @@ Please note that this project is released with a [Contributor Code of Conduct](C ## Submitting a pull request 0. [Fork][] and clone the repository -0. Build it and make sure the tests pass on your machine: `script/cibuild` +0. Build it and make sure the tests pass on your machine: `script/cibuild`. It will run both trilogy and ruby bindings suites in docker environment. + + To shorten the development loop you can: + + a) run trilogy tests locally with: `make clean all test` + b) runruby binding tests with `make clean ; cd contrib/ruby ; bundle exec rake test ; cd -`. It's possible to run a test single example by passing a `TESTOPTS` environment variable like so: `TESTOPTS=-n/test_packet_size_greater_than_trilogy_max_packet_len/`. + 0. Create a new branch: `git checkout -b my-branch-name` 0. Make your change, add tests, and make sure the tests still pass 0. Push to your fork and [submit a pull request][pr] From b0e9afa83ad83e87bb6c6171b6ef5a9c643df1fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Gw=C3=B3=C5=BAd=C5=BA?= Date: Thu, 8 Jun 2023 13:27:15 +0200 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 651893a1..9ed5d01f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,8 +16,8 @@ Please note that this project is released with a [Contributor Code of Conduct](C To shorten the development loop you can: - a) run trilogy tests locally with: `make clean all test` - b) runruby binding tests with `make clean ; cd contrib/ruby ; bundle exec rake test ; cd -`. It's possible to run a test single example by passing a `TESTOPTS` environment variable like so: `TESTOPTS=-n/test_packet_size_greater_than_trilogy_max_packet_len/`. + a) run trilogy tests locally with: `make clean all test` + b) runruby binding tests with `make clean ; cd contrib/ruby ; bundle exec rake test ; cd -`. It's possible to run a test single example by passing a `TESTOPTS` environment variable like so: `TESTOPTS=-n/test_packet_size_greater_than_trilogy_max_packet_len/`. 0. Create a new branch: `git checkout -b my-branch-name` 0. Make your change, add tests, and make sure the tests still pass From 667c899d10c604627820b72667f0f22e20f01072 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Gw=C3=B3=C5=BAd=C5=BA?= Date: Fri, 9 Jun 2023 10:40:31 +0200 Subject: [PATCH 3/3] Apply suggestions from code review --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ed5d01f..4dea470c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,8 +16,8 @@ Please note that this project is released with a [Contributor Code of Conduct](C To shorten the development loop you can: - a) run trilogy tests locally with: `make clean all test` - b) runruby binding tests with `make clean ; cd contrib/ruby ; bundle exec rake test ; cd -`. It's possible to run a test single example by passing a `TESTOPTS` environment variable like so: `TESTOPTS=-n/test_packet_size_greater_than_trilogy_max_packet_len/`. + a) run trilogy tests locally with: `make test` + b) run ruby binding tests with `cd contrib/ruby`, `bundle exec rake test`. It's possible to run a test single example by passing a `TESTOPTS` environment variable like so: `TESTOPTS=-n/test_packet_size_greater_than_trilogy_max_packet_len/`. 0. Create a new branch: `git checkout -b my-branch-name` 0. Make your change, add tests, and make sure the tests still pass