https://github.com/codecov/go-standard

Codecov coverage standard for go
https://github.com/codecov/go-standard

Last synced: 9 months ago
JSON representation

Codecov coverage standard for go

• Host: GitHub
• URL: https://github.com/codecov/go-standard
• Owner: codecov
• License: mit
• Created: 2019-08-26T00:59:07.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-12-05T22:52:22.000Z (about 1 year ago)
• Last Synced: 2025-04-11T15:10:25.332Z (9 months ago)
• Language: Python
• Size: 338 KB
• Stars: 14
• Watchers: 9
• Forks: 20
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# go-standard

[![Workflow for Go Standard Action](https://github.com/codecov/go-standard/actions/workflows/go-standard.yml/badge.svg)](https://github.com/codecov/go-standard/actions/workflows/go-standard.yml)[![codecov](https://codecov.io/gh/codecov/go-Standard/branch/master/graph/badge.svg)](https://codecov.io/gh/codecov/go-Standard)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fgo-standard.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fgo-standard?ref=badge_shield)

### Last Updated: 09/14/23 00:12:55

## What is this?

This is a **Go** application, with basic unit tests, for which coverage is uploaded to Codecov on a daily basis. It can also serve as an example for how to integrate Codecov into your Go project. If the build is passing for this project, then Codecov's Go report processing is functional and correct on codecov.io.

## Configuration

This project is written in `Go`. Unit test are written using the go `testing` framework and coverage reports are generated using the `go` CLI.

## Usage

### The Docker Way

Run unit tests inside a Docker container

```bash

chmod +x local.sh

./local.sh

```

### The Local Way

Run tests

```

go test -race -coverprofile=coverage.txt -covermode=atomic

```

## Reporting Issues

If you've discovered an issue with this repository or with Go processing in general, it is recommended to email support@codecov.io rather than post an issue here. This repository will not be checked regularly for open issues.

## Contributing

Contributions are welcome! If you'd like to contribute to this repository, feel free to open a pull request or flag an issue. If you would like to contribute a new lanaguage standard, [you can get more information here](https://github.com/codecov/standards-scripts/blob/master/README.md#contributing). 

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fgo-standard.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fgo-standard?ref=badge_large)