From 064b1b6d1c2beca282dd878e7fa869d1dff1eea3 Mon Sep 17 00:00:00 2001 From: "Chelsea H. Komlo" Date: Fri, 28 Oct 2016 20:20:40 -0500 Subject: [PATCH 1/3] Adds standard to run code changes against test suite --- doc/HACKING/CodingStandards.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md index 01212a9919..009047d6a3 100644 --- a/doc/HACKING/CodingStandards.md +++ b/doc/HACKING/CodingStandards.md @@ -7,6 +7,7 @@ tl;dr: - Run `make check-spaces` to catch whitespace errors - Document your functions - Write unit tests + - Run `make test-full` to test against all unit and integration tests. - Add a file in `changes` for your branch. Patch checklist @@ -26,6 +27,8 @@ Did you remember... - To run `make check-docs` to see whether all new options are on the manpage? - To write unit tests, as possible? + - To run `make test-full` to test against all unit and integration tests (or + `make test-full-online` if you have a working connection to the internet)? - To base your code on the appropriate branch? - To include a file in the `changes` directory as appropriate? From d95678ca8f97ac6e648598af01b4394840999e72 Mon Sep 17 00:00:00 2001 From: "Chelsea H. Komlo" Date: Wed, 21 Dec 2016 11:42:05 -0500 Subject: [PATCH 2/3] make distcheck should be a part of the local development process --- doc/HACKING/CodingStandards.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md index 009047d6a3..9932c77353 100644 --- a/doc/HACKING/CodingStandards.md +++ b/doc/HACKING/CodingStandards.md @@ -8,6 +8,7 @@ tl;dr: - Document your functions - Write unit tests - Run `make test-full` to test against all unit and integration tests. + - Run `make distcheck` to ensure the distribution works - Add a file in `changes` for your branch. Patch checklist @@ -29,6 +30,7 @@ Did you remember... - To write unit tests, as possible? - To run `make test-full` to test against all unit and integration tests (or `make test-full-online` if you have a working connection to the internet)? + - To test that the distribution will actually work via `make distcheck`? - To base your code on the appropriate branch? - To include a file in the `changes` directory as appropriate? From dfde58db6b4ca0b406b872d7b049efbe07d7a0fe Mon Sep 17 00:00:00 2001 From: "Chelsea H. Komlo" Date: Wed, 21 Dec 2016 17:07:57 -0500 Subject: [PATCH 3/3] check-spaces is run as part of make check --- doc/HACKING/CodingStandards.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md index 9932c77353..c7787a72cc 100644 --- a/doc/HACKING/CodingStandards.md +++ b/doc/HACKING/CodingStandards.md @@ -4,7 +4,6 @@ Coding conventions for Tor tl;dr: - Run configure with `--enable-fatal-warnings` - - Run `make check-spaces` to catch whitespace errors - Document your functions - Write unit tests - Run `make test-full` to test against all unit and integration tests. @@ -24,7 +23,6 @@ preference) Did you remember... - To build your code while configured with `--enable-fatal-warnings`? - - To run `make check-spaces` on your code? - To run `make check-docs` to see whether all new options are on the manpage? - To write unit tests, as possible?