sloum/bombadillo
sloum
/
bombadillo
5
27
Fork 7
Code Issues 18 Pull Requests 1 Releases 9 Activity

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

Manually merged
asdf merged 5 commits from support-different-go-versions into develop 2019-11-12 03:23:14 +00:00
Conversation 1 Commits 5 Files Changed 2 +12
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -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
Review
Copy Link

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

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
Review
Copy Link

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.

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.
# 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
sloum commented 2019-11-12 03:05:53 +00:00
Review
Copy Link

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
Review
Copy Link

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
Review
Copy Link

Cool. Looks good!

Cool. Looks good!

8
README.md
View File

@ -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.
- 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`.
sloum commented 2019-11-12 03:07:46 +00:00
Outdated
Review
Copy Link

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
Outdated
Review
Copy Link

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

OK I'll make that clearer, thanks for the feedback.
- Linting must be performed on new changes using `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.