Skip to content

Commit

Permalink
🤖 added CI; 🐛 fixed null related bug in log_metric
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurenzBeck committed Sep 3, 2024
1 parent fefff1d commit cdea0de
Show file tree
Hide file tree
Showing 14 changed files with 970 additions and 692 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/✅ task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "✅ Task"
about: "If something needs to be done."
title: '[TASK] '
labels: 'task'

---

## ✅ Task

Add a description of the task.

### 📃 Checklist

- [ ] sub-task1 description
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/🐛 bug report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: "🐛 Bug Report"
about: "If something isn't working as expected."
title: '[BUG] '
labels: 'bug'

---

## 🐛 Bug Report

> 🚮 delete any section that is not helpful/required for your report (including this message)
### 🔥 Current Behavior

A clear and concise description of the behavior.

### ✨ Expected Behavior

A clear and concise description of what you expected to happen (or code).

### 💻 Reproducing the Bug

Input Code, REPL or Repo link

#### 📄🖼️ Context and Screenshots

Add any other context about the problem here. If applicable, add screenshots to help explain.

#### 🐋 Environment

Add information about your environment if you think the bug is specific to your setup.

### 🤔 Possible Solution

Only if you have suggestions on a fix for the bug.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/🚀 feature request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "🚀 Feature Request"
about: "If you want to add/implement/request a new feature."
title: '[FEATURE] '
labels: 'enhancement'

---

## 🚀 Feature Request

> 🚮 feel free to delete any section that is not helpful/required for your report (including this message)
### 😞 Problem Statement

A clear and concise description of what the problem is. Ex. I have an issue when [...]

### 💬 Feature Description

A clear and concise description of what you want to happen. Add any considered drawbacks.

If you can, explain how users will be able to use this and possibly write out a version the docs.
Maybe a screenshot or design?

### 🤔 Alternatives

A clear and concise description of any alternative solutions or features you've considered.

### ✅ Implementation Checklist

- [ ] ...
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
> 🙇💖 Thank you for contributing to Skáld!
> 🚮 feel free to delete any section that is not helpful/required for your report (including this message)
## 💬 Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

## ❗ Issue Links
Fixes #<issue_number>

## 🧪 How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

# ✅ Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
33 changes: 33 additions & 0 deletions .github/workflows/python-package.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: CI

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: 🐍 Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- uses: Gr1N/setup-poetry@v9
with:
poetry-version: "1.8.3"
- uses: actions/cache@v4
with:
path: ~/.cache/pypoetry/virtualenvs
key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
- name: 🎶 Install dependencies with poetry
run: poetry install --all-extras --sync --compile
- name: ⚡ Lint with ruff
run: poetry run ruff check skald
- name: ⚗️ Test with pytest
run: poetry run poe test
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
</p>

<p align="center">
<a href="https://pypi.org/project/skald/"><img alt="Static Badge" src="https://img.shields.io/badge/📦_version-0.5.0-blue"></a>
<a href="https://pypi.org/project/skald/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/skald?label=%F0%9F%93%A6%20PyPi">
<a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public." /></a>
</p>

<p align="center">
<a href="https://www.python.org/"><img alt="Python" src="https://img.shields.io/badge/Python-3.11-yellow?logo=python"></a>
<a href="https://www.python.org/"><img alt="Python" src="https://img.shields.io/badge/Python-3.11|3.12-yellow?logo=python"></a>
<a href="https://python-poetry.org/"><img alt="Poetry" src="https://img.shields.io/badge/Poetry-1.8.2-blue?logo=Poetry"></a>
</p>

Expand Down
1 change: 1 addition & 0 deletions changelog/20.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
🧑‍💻 added CI
1 change: 1 addition & 0 deletions changelog/21.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
🤷 switched to ´"diagonal_relaxed"´ strategy in ´pl.concat´ when logging metrics
Loading

0 comments on commit cdea0de

Please sign in to comment.