Files
codecov-action/CONTRIBUTING.md
T

14 lines
917 B
Markdown
Raw Normal View History

2019-08-07 07:38:37 -07:00
# Contribution Guide
:tada: Thanks for taking the time to contribute! :tada:
The following is a set of guidelines for contributing to this repository, which is hosted in the [Codecov Organization](https://github.com/codecov) on GitHub.
## What does this repo do?
2019-08-07 08:13:13 -07:00
This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's meant to take formatted reports with code coverage stats and upload them to codecov.io. What's essentially happening in the background is that Actions is spinning up a Linux Docker container with the contents of this repository. Inside that container, we then call a shell scipt that runs Codecov's Bash uploader.
2019-08-07 07:38:37 -07:00
2019-08-07 08:09:29 -07:00
## PRs and Support
2019-08-07 08:14:31 -07:00
Feel free to clone, modify code and request a PR to this repository. All PRs will be reviewed by the Codecov team. If your PR has been sitting for a while or if you have any questions, ping us at support@codecov.io