From 95bbe7b4bfb1d19345932beb3daf1fe02be470f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cibrahim0814=E2=80=9D?= Date: Wed, 7 Aug 2019 07:38:37 -0700 Subject: [PATCH] add contributing guidelines --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..16a8c26 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# 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? + +This repo is a GitHub Action, meaning it integrates with the GitHub Actions CI/CD pipeline. It's mean 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. + +## Improvements + +Here's a list of things that would extend the functionality of this Action: + +* **Specify file path**: Currently, there's no way to specify a file path to a coverage report. This would have to be a user input that gets passed through to the Docker container +* **Codecov YAML location**: No way to indicate a path to the `codecov.yml` file. Obtain from user input. +* **Upload flags**: Cannot currently specify any flags. Obtain from user input. + +This is primarily an effort in bash scripting and getting the information above from a user through to make a correct curl call \ No newline at end of file