From 98ca628b5370b9ca2a13b6007fcac8e2cfd0a897 Mon Sep 17 00:00:00 2001 From: Simon Swan Date: Thu, 16 Sep 2021 16:48:42 +0100 Subject: [PATCH 1/2] Remove old templates and tweak new templates. (#130) --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 29 ----------------------- .github/ISSUE_TEMPLATE/config.yml | 3 +++ .github/ISSUE_TEMPLATE/feature.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 20 ---------------- .github/ISSUE_TEMPLATE/issue.yml | 5 ++-- 6 files changed, 8 insertions(+), 55 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 766929ae..25e4b1b9 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,7 +1,7 @@ --- name: 🐞 Bug description: File a bug/issue -title: "[BUG] " +title: "<title>" labels: "bug,status:triage" body: - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 074e436a..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Bug report -about: Submit a bug report. -title: '' -labels: bug, status:triage -assignees: simonhkswan - ---- - -**Describe the bug** -<!--- A clear and concise description of what the bug is. ---> - -**To Reproduce** -<!--- Steps to reproduce the behaviour: ---> -```pycon ->>> import fairlens as fl ->>> import pandas as pd ->>> df = pd.read_csv(...) -... -``` - -**Expected behaviour** -<!--- A clear and concise description of what you expected to happen. ---> - -**Screenshots** -<!--- If applicable, add screenshots to help explain your problem. ---> - -**Additional context** -<!--- Add any other context about the problem here. ---> diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 09501d73..6bd8fb50 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,4 +3,7 @@ contact_links: - name: Fairlens community discussions url: https://github.com/synthesized-io/fairlens/discussions about: Please ask and answer questions here. + - name: Fairlens Documentation + url: https://fairlens.readthedocs.io/en/latest/ + about: Checkout our latest documentation. ... diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index aad68610..bd5bda7a 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,8 +1,8 @@ --- name: Feature Request description: Propose a new feature for development -title: "[FEATURE] <title>" -labels: "status:triage" +title: "<title>" +labels: "feature,status:triage" body: - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 2978ec58..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Propose a new feature for development. -title: '' -labels: status:triage -assignees: simonhkswan - ---- - -**Is your feature request related to a problem? Please describe.** -<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] ---> - -**Describe the solution you'd like** -<!--- A clear and concise description of what you want to happen. ---> - -**Describe alternatives you've considered** -<!--- A clear and concise description of any alternative solutions or features you've considered. ---> - -**Additional context** -<!--- Add any other context or screenshots about the feature request here. ---> diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index ecdc578d..fb4d3603 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -1,7 +1,7 @@ --- name: General Issue description: Raise a general issue for the project -title: "[ISSUE] <title>" +title: "<title>" labels: "status:triage" body: - type: checkboxes @@ -17,11 +17,10 @@ body: description: How would you best classify the scope of this issue, using the categories below? multiple: true options: - - Bug - CI/CD - Documentation - Improvement - - Feature + - Maintainance/Refactor validations: required: true - type: textarea From 432b1202d7dc051cff7284e7c7f30fc5d37465e7 Mon Sep 17 00:00:00 2001 From: Simon Swan <simon@synthesized.io> Date: Thu, 16 Sep 2021 17:19:17 +0100 Subject: [PATCH 2/2] add codecov.yml (#131) * add codecov.yml * Add codecov upload to ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update ci.yml * Update README.md * Update codecov.yml * Update ci.yml Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .github/workflows/ci.yml | 11 ++++++++++- README.md | 2 +- codecov.yml | 11 +++++++++++ 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 codecov.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index eb09a529..9c89665f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,6 +16,7 @@ jobs: - 3.7 - 3.8 - 3.9 + name: Check Python ${{ matrix.python-version }} steps: - uses: actions/checkout@v2.3.4 @@ -44,6 +45,14 @@ jobs: env: SYNTHESIZED_KEY: ${{ secrets.SYNTHESIZED_KEY }} + - name: Upload Codecov report + if: ${{ matrix.python-version }} == '3.7' + uses: codecov/codecov-action@v1.5.2 + with: + files: coverage-reports/cobertura.xml + flags: unittests + fail_ci_if_error: false + - name: SonarCloud Scan if: ${{ matrix.python-version }} == '3.7' uses: SonarSource/sonarcloud-github-action@master @@ -57,7 +66,7 @@ jobs: build-docs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v2.3.4 - uses: actions/setup-python@v2 with: diff --git a/README.md b/README.md index 1e4bfee9..32134331 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=synthesized-io_fairlens&metric=sqale_rating&token=4df8d79db869c4f81a2225da446ca06d3b83d4be)](https://sonarcloud.io/dashboard?id=synthesized-io_fairlens) -[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=synthesized-io_fairlens&metric=coverage&token=4df8d79db869c4f81a2225da446ca06d3b83d4be)](https://sonarcloud.io/dashboard?id=synthesized-io_fairlens) +[![codecov](https://codecov.io/gh/synthesized-io/fairlens/branch/main/graph/badge.svg?token=0EWTY95MU0)](https://codecov.io/gh/synthesized-io/fairlens) ![GitHub Repo stars](https://img.shields.io/github/stars/synthesized-io/fairlens?style=social) # FairLens diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 00000000..2d7763b2 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,11 @@ +--- +coverage: + status: + project: + default: + target: auto # auto compares coverage to the previous base commit + threshold: 1% + patch: + default: + target: 50% +...