From b35ceb14d63ae0c53200aa9f616eb8ea1d900deb Mon Sep 17 00:00:00 2001 From: asdf Date: Thu, 7 Nov 2019 22:29:22 +1100 Subject: [PATCH 1/4] Added developer documentation, testing to Makefile --- Makefile | 4 ++++ README.md | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/Makefile b/Makefile index ed3e3b6..d8d2c33 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ BINDIR := ${EXEC_PREFIX}/bin DATAROOTDIR := ${PREFIX}/share MANDIR := ${DATAROOTDIR}/man MAN1DIR := ${MANDIR}/man1 +test : GOCMD := go1.11.13 # Use a dateformat rather than -I flag since OSX # does not support -I. It also doesn't support @@ -47,3 +48,6 @@ clean: uninstall: clean rm -f ${DESTDIR}${MAN1DIR}/bombadillo.1.gz rm -f ${DESTDIR}${BINDIR}/${BINARY} + +.PHONY: test +test: clean build diff --git a/README.md b/README.md index 72cd746..4738877 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,14 @@ We aim for simplicity and quality, and do our best to make Bombadillo useful to The maintainers use the [tildegit](https://tildegit.org) issues system to discuss new features, track bugs, and communicate with users regarding issues and suggestions. Pull requests should typically have an associated issue, and should target the `develop` branch. +## Development + +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 is tested against Go 1.11. 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'. +- Linting is performed by `gofmt` and [golangci-lint](https://github.com/golangci/golangci-lint) + ## License This project is licensed under the GNU GPL version 3. See the [LICENSE](LICENSE) file for details. From 45eabef94518700eab7beffa46bfe70f0bbf3092 Mon Sep 17 00:00:00 2001 From: asdf Date: Thu, 7 Nov 2019 22:29:22 +1100 Subject: [PATCH 2/4] Added developer documentation, testing to Makefile --- Makefile | 4 ++++ README.md | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/Makefile b/Makefile index ed3e3b6..d8d2c33 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ BINDIR := ${EXEC_PREFIX}/bin DATAROOTDIR := ${PREFIX}/share MANDIR := ${DATAROOTDIR}/man MAN1DIR := ${MANDIR}/man1 +test : GOCMD := go1.11.13 # Use a dateformat rather than -I flag since OSX # does not support -I. It also doesn't support @@ -47,3 +48,6 @@ clean: uninstall: clean rm -f ${DESTDIR}${MAN1DIR}/bombadillo.1.gz rm -f ${DESTDIR}${BINDIR}/${BINARY} + +.PHONY: test +test: clean build diff --git a/README.md b/README.md index 72cd746..4738877 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,14 @@ We aim for simplicity and quality, and do our best to make Bombadillo useful to The maintainers use the [tildegit](https://tildegit.org) issues system to discuss new features, track bugs, and communicate with users regarding issues and suggestions. Pull requests should typically have an associated issue, and should target the `develop` branch. +## Development + +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 is tested against Go 1.11. 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'. +- Linting is performed by `gofmt` and [golangci-lint](https://github.com/golangci/golangci-lint) + ## License This project is licensed under the GNU GPL version 3. See the [LICENSE](LICENSE) file for details. From 36e52477eb6a15a2997f46348436bcef62b6a3a1 Mon Sep 17 00:00:00 2001 From: asdf Date: Tue, 12 Nov 2019 13:05:15 +1100 Subject: [PATCH 3/4] Further generalisation of development advice --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4738877..2697745 100644 --- a/README.md +++ b/README.md @@ -130,8 +130,8 @@ The maintainers use the [tildegit](https://tildegit.org) issues system to discus 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 is tested against Go 1.11. 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'. -- Linting is performed by `gofmt` and [golangci-lint](https://github.com/golangci/golangci-lint) +- 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'. +- Linting must be performed on new changes using `gofmt` and [golangci-lint](https://github.com/golangci/golangci-lint) ## License From 494a70859efc025be1a30974dd0a2d12d827ac85 Mon Sep 17 00:00:00 2001 From: asdf Date: Tue, 12 Nov 2019 14:21:10 +1100 Subject: [PATCH 4/4] Incorporated feedback --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2697745..8a64232 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ The maintainers use the [tildegit](https://tildegit.org) issues system to discus 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'. +- The build process must be tested with 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). Check that changes build with this version using `make test`. - Linting must be performed on new changes using `gofmt` and [golangci-lint](https://github.com/golangci/golangci-lint) ## License