-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update default branch from master to main
- Loading branch information
Showing
8 changed files
with
51 additions
and
52 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ | |
[![Security Scan](https://github.com/newrelic/newrelic-client-go/workflows/Security%20Scan/badge.svg)](https://github.com/newrelic/newrelic-client-go/actions) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/newrelic/newrelic-client-go?style=flat-square)](https://goreportcard.com/report/github.com/newrelic/newrelic-client-go) | ||
[![GoDoc](https://godoc.org/github.com/newrelic/newrelic-client-go?status.svg)](https://godoc.org/github.com/newrelic/newrelic-client-go) | ||
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/newrelic/newrelic-client-go/blob/master/LICENSE) | ||
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/newrelic/newrelic-client-go/blob/main/LICENSE) | ||
[![CLA assistant](https://cla-assistant.io/readme/badge/newrelic/newrelic-client-go)](https://cla-assistant.io/newrelic/newrelic-client-go) | ||
[![Release](https://img.shields.io/github/release/newrelic/newrelic-client-go/all.svg)](https://github.com/newrelic/newrelic-client-go/releases/latest) | ||
|
||
|
@@ -53,26 +53,26 @@ func main() { | |
|
||
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. | ||
|
||
* [Roadmap](https://newrelic.github.io/developer-toolkit/roadmap/) - As part of the Developer Toolkit, the roadmap for this project follows the same RFC process | ||
* [Issues or Enhancement Requests](https://github.com/newrelic/newrelic-client-go/issues) - Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue. | ||
* [Contributors Guide](CONTRIBUTING.md) - Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). | ||
* [Community discussion board](https://discuss.newrelic.com/c/build-on-new-relic/developer-toolkit) - Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. | ||
- [Roadmap](https://newrelic.github.io/developer-toolkit/roadmap/) - As part of the Developer Toolkit, the roadmap for this project follows the same RFC process | ||
- [Issues or Enhancement Requests](https://github.com/newrelic/newrelic-client-go/issues) - Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue. | ||
- [Contributors Guide](CONTRIBUTING.md) - Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). | ||
- [Community discussion board](https://discuss.newrelic.com/c/build-on-new-relic/developer-toolkit) - Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. | ||
|
||
Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at [email protected]. | ||
|
||
## Development | ||
|
||
### Requirements | ||
|
||
* Go 1.14.0+ | ||
* GNU Make | ||
* git | ||
- Go 1.14.0+ | ||
- GNU Make | ||
- git | ||
|
||
### Building | ||
|
||
This package does not generate any direct usable assets (it's a library). You can still run the build scripts to validate you code, and generate coverage information. | ||
This package does not generate any direct usable assets (it's a library). You can still run the build scripts to validate you code, and generate coverage information. | ||
|
||
``` bash | ||
```bash | ||
# Default target is 'build' | ||
$ make | ||
|
||
|
@@ -89,7 +89,7 @@ Before contributing, all linting and tests must pass. | |
|
||
Tests can be run directly via: | ||
|
||
``` bash | ||
```bash | ||
# Tests and Linting | ||
$ make test | ||
|
||
|
@@ -108,7 +108,7 @@ need to be configured in the environment or else the integraiton tests will be s | |
during a test run. To run the integration test suite, the following secrets will | ||
need to be configured: | ||
|
||
``` bash | ||
```bash | ||
NEW_RELIC_ACCOUNT_ID | ||
NEW_RELIC_API_KEY | ||
NEW_RELIC_INSIGHTS_INSERT_KEY | ||
|
@@ -119,16 +119,16 @@ NEW_RELIC_TEST_USER_ID | |
|
||
Optional for debugging (defaults to `debug`): | ||
|
||
``` bash | ||
```bash | ||
NEW_RELIC_LOG_LEVEL=trace | ||
``` | ||
|
||
#### Go Version Support | ||
|
||
We'll aim to support the latest supported release of Go, along with the | ||
previous release. This doesn't mean that building with an older version of Go | ||
previous release. This doesn't mean that building with an older version of Go | ||
will not work, but we don't intend to support a Go version in this project that | ||
is not supported by the larger Go community. Please see the [Go | ||
is not supported by the larger Go community. Please see the [Go | ||
releases][go_releases] page for more details. | ||
|
||
### Commit Messages | ||
|
@@ -140,34 +140,34 @@ the [CHANGELOG](CHANGELOG.md): | |
|
||
`<type>(<scope>): <subject>` | ||
|
||
| Type | Description | Change log? | | ||
|------| ----------- | :---------: | | ||
| `chore` | Maintenance type work | No | | ||
| `docs` | Documentation Updates | Yes | | ||
| `feat` | New Features | Yes | | ||
| `fix` | Bug Fixes | Yes | | ||
| `refactor` | Code Refactoring | No | | ||
| Type | Description | Change log? | | ||
| ---------- | --------------------- | :---------: | | ||
| `chore` | Maintenance type work | No | | ||
| `docs` | Documentation Updates | Yes | | ||
| `feat` | New Features | Yes | | ||
| `fix` | Bug Fixes | Yes | | ||
| `refactor` | Code Refactoring | No | | ||
|
||
#### Scope | ||
|
||
This refers to what part of the code is the focus of the work. For example: | ||
This refers to what part of the code is the focus of the work. For example: | ||
|
||
**General:** | ||
|
||
* `build` - Work related to the build system (linting, makefiles, CI/CD, etc) | ||
* `release` - Work related to cutting a new release | ||
- `build` - Work related to the build system (linting, makefiles, CI/CD, etc) | ||
- `release` - Work related to cutting a new release | ||
|
||
**Package Specific:** | ||
|
||
* `newrelic` - Work related to the New Relic package | ||
* `http` - Work related to the `internal/http` package | ||
* `alerts` - Work related to the `pkg/alerts` package | ||
- `newrelic` - Work related to the New Relic package | ||
- `http` - Work related to the `internal/http` package | ||
- `alerts` - Work related to the `pkg/alerts` package | ||
|
||
### Documentation | ||
|
||
**Note:** This requires the repo to be in your GOPATH [(godoc issue)](https://github.com/golang/go/issues/26827) | ||
|
||
``` bash | ||
```bash | ||
$ make docs | ||
``` | ||
|
||
|
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