docs: update go version in CONTRIBUTING. #23310
Open
+110
−89
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
- update the Go requirement to 1.18 in CONTRIBUTING.md - remove mention of GPG key since it's no longer at the referenced URL and @pierwill verified it's not currently necessary. - revisions and cleanup.
kelseiv
approved these changes
Apr 28, 2022
|
|
||
| At InfluxData we find `gvm`, a Go version manager, useful for installing Go. | ||
| For instructions on how to install it see [the gvm page on github](https://github.com/moovweb/gvm). | ||
| With `gvm` installed, run the following commands to install the required go version and set it as the default. |
There was a problem hiding this comment.
Suggested change
| With `gvm` installed, run the following commands to install the required go version and set it as the default. | |
| With `gvm` installed, run the following commands to install the required Go version and set it as the default. |
| @@ -13,4 +13,4 @@ These versions of InfluxDB are currently being supported with security updates. | |||
|
|
|||
| ## Reporting a Vulnerability | |||
There was a problem hiding this comment.
Suggested change
| ## Reporting a Vulnerability | |
| ## Report a vulnerability |
|
|
||
| $ ./influxd -cpuprofile influxdcpu.prof -memprof influxdmem.prof | ||
|
|
||
| # run queries, writes, whatever you're testing | ||
| # Run queries, writes, or whatever you're testing. | ||
| # Quit out of influxd and influxd.prof will then be written. |
There was a problem hiding this comment.
Suggested change
| # Quit out of influxd and influxd.prof will then be written. | |
| # Quit influxd to write to influxd.prof. |
| # Quit out of influxd and influxd.prof will then be written. | ||
| # open up pprof to examine the profiling data. | ||
| # Run pprof to examine the profiling data. |
There was a problem hiding this comment.
does pprof show what's in influxd.prof?
|
|
||
| - Ensure Go can find the protobuf library on your system--check that `LD_LIBRARY_PATH` includes the directory where the `libprotoc.so` library is installed. | ||
| - Ensure the `protoc-gen-go` executable in `GOPATH/bin` is on your system path by adding `GOPATH/bin` to `PATH`. | ||
|
|
||
| ## Generated Go Templates |
There was a problem hiding this comment.
Suggested change
| ## Generated Go Templates | |
| ## Generated Go templates |
|
|
||
| There will usually be some back and forth as we finalize the change, but once that completes it may be merged. | ||
| - Be clear about your requirements and goals. | ||
| - Provide examples of the enhancement that you would like to see and tell us why it's important to you. |
There was a problem hiding this comment.
Suggested change
| - Provide examples of the enhancement that you would like to see and tell us why it's important to you. | |
| - Examples of the enhancement that you would like to see, and why it's important to you. |
| There will usually be some back and forth as we finalize the change, but once that completes it may be merged. | ||
| - Be clear about your requirements and goals. | ||
| - Provide examples of the enhancement that you would like to see and tell us why it's important to you. | ||
| - If you find your feature request already exists as a Github issue, please add a "thumbs up" reaction to indicate your support for that feature. |
There was a problem hiding this comment.
Suggested change
| - If you find your feature request already exists as a Github issue, please add a "thumbs up" reaction to indicate your support for that feature. | |
| {{% note %}} | |
| If you find your feature request already exists as a Github issue, please add a "thumbs up" reaction to indicate your support for that feature. | |
| {{% /note %}} |
| To submit a pull request, follow these steps: | ||
|
|
||
| 1. Fork the `influxdata/influxdb` repository. | ||
| 2. Checkout a feature branch in your fork. |
There was a problem hiding this comment.
Suggested change
| 2. Checkout a feature branch in your fork. | |
| 2. Check out a feature branch in your fork (`git checkout <branch name>`). |
|
|
||
| To submit a pull request, follow these steps: | ||
|
|
||
| 1. Fork the `influxdata/influxdb` repository. |
There was a problem hiding this comment.
Suggested change
| 1. Fork the `influxdata/influxdb` repository. | |
| 1. [Fork the `influxdata/influxdb` repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) . |
|
|
||
| 1. Fork the `influxdata/influxdb` repository. | ||
| 2. Checkout a feature branch in your fork. | ||
| 3. In your feature branch, make your change and run the test suite (given you won't be able to merge if tests fail). |
There was a problem hiding this comment.
Suggested change
| 3. In your feature branch, make your change and run the test suite (given you won't be able to merge if tests fail). | |
| 3. In your feature branch, make your change and run the test suite (you won't be able to merge if tests fail). |
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.
Describe your proposed changes here.