From 8626a3b9ba4abbd4653606a298bc995335218b27 Mon Sep 17 00:00:00 2001 From: Layf <93056040+Layf21@users.noreply.github.com> Date: Wed, 19 Nov 2025 13:13:00 +0100 Subject: [PATCH] ci/docs: Implement GitHub flow Start using GitHub flow by removing the long lived dev branch as it is unnecessary in my use case. - removed "dev" branch from ci workflow - renamed workflows from .yaml to .yml - updated README Contributing note to reflect changes --- .github/workflows/{bump-version.yaml => bump-version.yml} | 0 .github/workflows/{ci.yaml => ci.yml} | 4 ++-- .github/workflows/{publish.yaml => publish.yml} | 0 README.md | 4 ++-- 4 files changed, 4 insertions(+), 4 deletions(-) rename .github/workflows/{bump-version.yaml => bump-version.yml} (100%) rename .github/workflows/{ci.yaml => ci.yml} (92%) rename .github/workflows/{publish.yaml => publish.yml} (100%) diff --git a/.github/workflows/bump-version.yaml b/.github/workflows/bump-version.yml similarity index 100% rename from .github/workflows/bump-version.yaml rename to .github/workflows/bump-version.yml diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yml similarity index 92% rename from .github/workflows/ci.yaml rename to .github/workflows/ci.yml index 6ead2ae..73a790e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yml @@ -2,9 +2,9 @@ name: CI on: push: - branches: [ "dev", "main" ] + branches: [ "main" ] pull_request: - branches: [ "dev", "main" ] + branches: [ "main" ] jobs: test: diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yml similarity index 100% rename from .github/workflows/publish.yaml rename to .github/workflows/publish.yml diff --git a/README.md b/README.md index 0bbb3f6..55dd136 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,8 @@ asyncio.run(main()) ## Contributing 1. Fork the repository -2. Create a new branch under feature/* -3. Submit a pull request into dev with your improvements +2. Create a feature branch feature/[your-feature], branching off from main +3. Submit a pull request to main with your improvements This project uses [Hatch](https://hatch.pypa.io/).