Skip to content

Commit

Permalink
update template
Browse files Browse the repository at this point in the history
  • Loading branch information
SAKURA-CAT committed Jun 14, 2024
1 parent 4d8e703 commit 34926cb
Show file tree
Hide file tree
Showing 7 changed files with 171 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/ask for question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: 🙋 Ask for question
about: Look for some help or ask question
title: '[QUESTION] '
labels: question
assignees: ''
---

### 🤔 Question description [Please make everyone to understand it]

### 🧑‍💻 Expected result

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

<!-- Describe your bugs below ^_^ -->

## 🐛 Bug description [Please make everyone to understand it]

Describe the main elements of the bug

## 🧑‍💻 Step to reproduce

1. Go to '....'

2. Click '....'

3. Something happened '....'

## 👾 Expected result

Write down the results you expect

## 🚑 Any additional [like screenshots]

- **SwanLab Version**:

- **Swanboard Version**:

- **Platform**:
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature advice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: 🏠 Feature advice
about: Suggest an idea for this project
title: '[ADVICE] '
labels: enhancement
assignees: ''
---

## 🤪 Features description [Please make everyone to understand it]

Briefly describe this feature

## 👍 What problem does this feature solve

## 👾 What does the proposed API look like

## 🚑 Any additional [like screenshots]

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: 💪 Feature request
about: The iterative goal of this project
title: '[REQUEST] '
labels: enhancement
assignees: ''
---

## 🤩 Features description [Please make everyone to understand it]

Briefly describe this feature

## 👍 What problem does this feature solve

## 👾 What does the proposed API look like

## 🚑 Any additional [like screenshots]

17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Description

Please include a concise summary, in clear English, of the changes in this pull request. If it closes an issue, please
mention it here.

Closes: #(issue)

## 🎯 PRs Should Target Issues

Before your creating a PR, please check to see if there
is [an existing issue](https://github.com/SwanHubX/SwanLab-Toolkit/issues)
for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

<!-- ## Tests -->
<!-- There are no hive tests yet -->
43 changes: 43 additions & 0 deletions .github/workflows/publish-to-pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Publish to PyPI

on:
push:
tags:
- "v*.*.*"

jobs:
publish:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set Python
uses: actions/setup-python@v5
with:
python-version: "3.8"

- name: Install Dependencies
run: |
pip install -r requirements-dev.txt
pip install build
pip install twine
- name: Build and Publish
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}

run: |
python -m build
python -m twine upload dist/*
# - run: cp dist/*.whl .
# - name: Release
# uses: softprops/action-gh-release@v1
# if: startsWith(github.ref, 'refs/tags/')
# with:
# body: ${{ github.event.head_commit.message }}
# files: |
# *.whl
30 changes: 30 additions & 0 deletions .github/workflows/test-when-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Test When PR

on:
pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ 3.8, 3.9, 3.10, 3.11, 3.12 ]

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}

- name: Install Dependencies
run: |
pip install -r requirements-dev.txt
- name: Test
run: |
pytest test/unit

0 comments on commit 34926cb

Please sign in to comment.