Add some development information per #81 and #65 #84

asdf · 2019-11-12T02:11:09Z

asdf commented

2019-11-12 02:11:09 +00:00

This adds some basic and general information about development, testing standard and linting standard.

The makefile has a new target to test against go1.11.13.

This is my intended resolution for #81 and also some additional coverage for #65.

This adds some basic and general information about development, testing standard and linting standard. The makefile has a new target to test against go1.11.13. This is my intended resolution for #81 and also some additional coverage for #65.

asdf self-assigned this 2019-11-12 02:11:09 +00:00

sloum was assigned by asdf

2019-11-12 02:11:09 +00:00

asdf added the

labels 2019-11-12 02:11:09 +00:00

sloum approved these changes 2019-11-12 03:08:06 +00:00

Makefile

						
				@ -6,6 +6,7 @@ BINDIR := ${EXEC_PREFIX}/bin

				DATAROOTDIR := ${PREFIX}/share

				MANDIR := ${DATAROOTDIR}/man

				MAN1DIR := ${MANDIR}/man1

				test : GOCMD := go1.11.13

sloum commented

2019-11-12 03:05:04 +00:00

I have not seen this construct in a Makefile. I assume this scopes GOCMD to test?

asdf commented

2019-11-12 03:11:47 +00:00

Yes, for the target test, the GOCMD variable is set to go1.11.13. It is also still possible to override it from the command line if you really like.

Makefile

						
				@ -49,1 +50,4 @@

					rm -f ${DESTDIR}${BINDIR}/${BINARY}

				.PHONY: test

				test: clean build

sloum commented

2019-11-12 03:05:53 +00:00

So test in this case does not run tests, it creates a build with the standardized version so that we can know that it will build on t hat version, yeah?

So test in this case does not run tests, it creates a build with the standardized version so that we can know that it _will_ build on t hat version, yeah?

asdf commented

2019-11-12 03:12:51 +00:00

Yes, that's exactly right. It is also possible to expand it to include commands like go test.

Yes, that's exactly right. It is also possible to expand it to include commands like `go test`.

sloum commented

2019-11-12 03:23:57 +00:00

Cool. Looks good!

README.md Outdated

						
				@ -128,0 +130,4 @@

				Following the standard install instructions should lead you to have nearly everything you need to commence development. The only additions to this are:

				- To be able to submit pull requests, you will need to fork this repository first.

				- Bombadillo must be tested against Go 1.11 to ensure backward compatibility. This version can be installed as per the [Go install documentation](https://golang.org/doc/install#extra_versions). Tests for this version are run using 'make test'.

sloum commented

2019-11-12 03:07:46 +00:00

It seems as though make test does not actually run tests (at present at least), should we reword this for the time being to say that it will generate a test build with that version of the compiler?

It seems as though `make test` does not actually run tests (at present at least), should we reword this for the time being to say that it will generate a test build with that version of the compiler?

asdf commented

2019-11-12 03:13:25 +00:00

OK I'll make that clearer, thanks for the feedback.