-
Notifications
You must be signed in to change notification settings - Fork 142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update the contributing & readme files, improve makefile #79
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
fho
commented
Apr 21, 2022
•
edited
Loading
edited
1. If the AMQP_URL environment variable is not set, use amqp://guest:[email protected]:5672/ as default and print an informal message to stdout 2. Simplify it and don't duplicate retrieving the AMQP_URL from an environment variable. A amqpURL global variable is now defined that is set to the value of the AMQP_URL enviroment variable in an init() function. Tests function can reference the global variable instead of retrieving the env variable every time.
Don't set the AMQP_URL environment variable when running "make tests". It overwrote the environment variable and made it impossible to use another URL + "make tests"
Clarify the documentation, make it clear that test-servers can be reachable also via other URLs, document that "make tests" can be used.
The script seems very outdated: - it seems unused(?) - it only runs some tools when the very old go version 1.11 is used, that the script considers as the stable version, go 1.11 is not even supported anymore, in go.mod the min. version is to 1.16 - it runs golint and govet which are also run by golangci-lint, - it does not use the Makefile at all Remove it also from the CONTRIBUTING.md file.
- remove note about installing "golint", it is not needed - add a chapter about running the static checks similar to the one about running integration tests, - mention it in the workflow
Instead of duplicating the information that is already in the CONTRIBUTING.md file, reference the CONTRIBUTING.md file. Also remove the sentence that TravisCI is used, it is not.
The directory is named "_examples" not "examples", also use a link as reference
fho
commented
Apr 21, 2022
fho
changed the title
docs: Update the contributing, readme, improve makefile
docs: Update the contributing & readme files, improve makefile
Apr 21, 2022
fho
changed the title
docs: Update the contributing & readme files, improve makefile
update the contributing & readme files, improve makefile
Apr 21, 2022
lukebakken
approved these changes
Apr 21, 2022
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.