From 9af29a115b76903f9dc4d7d76573cb1af03cf5f7 Mon Sep 17 00:00:00 2001 From: Laurence Young Date: Thu, 24 Sep 2026 14:33:14 +0800 Subject: [PATCH] chore: bootstrap repository standards --- .github/workflows/ci.yml | 50 ++++++++ .github/workflows/release.yml | 32 +++++ .gitignore | 219 ++++++++++++++++++++++++++++++++++ .markdownlint.json | 4 + .releaserc.json | 8 ++ AGENTS.md | 103 ++++++++++++++++ LICENSE | 202 +++++++++++++++++++++++++++++++ README.md | 34 +++++- 8 files changed, 651 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 .markdownlint.json create mode 100644 .releaserc.json create mode 100644 AGENTS.md create mode 100644 LICENSE diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..042b309 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,50 @@ +# Test gate for a repository that currently ships documentation only. +# +# Tests live in their own workflow: they run on pull requests, while the release +# workflow runs on pushes to the default branch. Mixing the two means a broken +# release blocks a pull request, or the reverse. +# +# Replace the test step with the project's real toolchain and test command as soon +# as source code lands; see the repository standards in AGENTS.md. +# +# AGENTS.md is deliberately not linted: it is canonical content synced from +# repo-template and must not be edited here. +name: CI + +on: + pull_request: + push: + branches: + - main + +permissions: + contents: read + +concurrency: + group: ci-${{ github.ref }} + cancel-in-progress: true # a superseded pull request run is pointless + +jobs: + test: + runs-on: ubuntu-22.04 + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: 22 + + - name: Lint Markdown + run: npx --yes markdownlint-cli2@0.23.3 "README.md" + + - name: Validate repository standards + run: | + set -euo pipefail + test -s README.md + test -s AGENTS.md + test -s LICENSE + python3 -c "import json; json.load(open('.releaserc.json'))" + python3 -c "import json; json.load(open('.markdownlint.json'))" + echo "repository standards OK" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..4264251 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,32 @@ +# Copy this file into a downstream repository as `.github/workflows/release.yml`. +# `scripts/sync.sh` does that automatically when the file does not exist yet. +# +# This is the source-only shape: compute the version, create the tag, create the +# GitHub release. GitHub attaches the source tarball and zip to every release by +# itself, so nothing else is required. +# +# Add the `publish` job from examples/publish.yml when the repository publishes to +# a registry, and the `package` job from examples/package.yml when it ships build +# artifacts. Both are independent siblings of `release`: add or delete them freely. +name: Release + +on: + push: + branches: + - main + - master + +permissions: + contents: write # create the tag and the GitHub release + issues: write # comment on released issues + pull-requests: write # comment on released pull requests + +concurrency: + group: release-${{ github.ref }} + cancel-in-progress: false # never cancel a release mid-flight + +jobs: + # Versioning only: commit prefixes -> tag -> GitHub release. Language-agnostic. + release: + # Pin to a moving major tag (`@v1`), or to a commit SHA for maximum safety. + uses: nexform-tech/repo-template/.github/workflows/release.yml@v1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8c02273 --- /dev/null +++ b/.gitignore @@ -0,0 +1,219 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[codz] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py.cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +# Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +# poetry.lock +# poetry.toml + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python. +# https://pdm-project.org/en/latest/usage/project/#working-with-version-control +# pdm.lock +# pdm.toml +.pdm-python +.pdm-build/ + +# pixi +# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control. +# pixi.lock +# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one +# in the .venv directory. It is recommended not to include this directory in version control. +.pixi + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# Redis +*.rdb +*.aof +*.pid + +# RabbitMQ +mnesia/ +rabbitmq/ +rabbitmq-data/ + +# ActiveMQ +activemq-data/ + +# SageMath parsed files +*.sage.py + +# Environments +.env +.envrc +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +# .idea/ + +# Abstra +# Abstra is an AI-powered process automation framework. +# Ignore directories containing user credentials, local state, and settings. +# Learn more at https://abstra.io/docs +.abstra/ + +# Visual Studio Code +# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore +# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore +# and can be added to the global gitignore or merged into this file. However, if you prefer, +# you could uncomment the following to ignore the entire vscode folder +# .vscode/ +# Temporary file for partial code execution +tempCodeRunnerFile.py + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + +# Marimo +marimo/_static/ +marimo/_lsp/ +__marimo__/ + +# Streamlit +.streamlit/secrets.toml + diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..9b14487 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": { "line_length": 130, "tables": false, "code_blocks": false }, + "MD060": { "style": "padded" } +} diff --git a/.releaserc.json b/.releaserc.json new file mode 100644 index 0000000..a754d87 --- /dev/null +++ b/.releaserc.json @@ -0,0 +1,8 @@ +{ + "branches": ["main", "master"], + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + "@semantic-release/github" + ] +} diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..81db696 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,103 @@ +# AGENTS.md + +Operating rules for agents working in this repository. They are mandatory, not advisory. + +## 1. Git Workflow + +These rules assume the repository is hosted on GitHub. Where it has no GitHub remote, the GitHub-specific steps (PRs, issues, releases) do not apply; branching, commit, and testing rules apply to every Git repository. + +**Never modify code directly on the default branch.** Always create a new branch first. + +- The default branch may be `main` or `master`; `` below means whichever it is. +- Sync before branching: `git switch && git pull --ff-only`. +- Create a branch: `git switch -c /`. + - Examples: `feat/oauth-login`, `fix/null-pointer-on-logout`, `chore/bump-deps`. + - `` is one of the commit types listed below. +- Keep branches small and single-purpose. One branch solves one problem. +- Keep the branch current by rebasing on ``; do not merge `` into it. +- Never rewrite history that has already been pushed to a shared branch. + +### Commits + +Every commit message follows Conventional Commits: + +``` +: + + + +