diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fd3dcc8..465f339 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,12 +6,14 @@ This guide will help you get started. ## 🛠 Project Setup 1. Clone the repository: + ```bash git clone https://github.com/your-username/aeonview.git cd aeonview ``` 2. Set up your environment: + ```bash python3 -m venv venv source venv/bin/activate @@ -19,6 +21,7 @@ This guide will help you get started. ``` 3. Install pre-commit hooks: + ```bash pre-commit install ``` @@ -46,17 +49,20 @@ make lint # check for lint errors ## ✅ Submitting a Pull Request 1. Create a feature branch: + ```bash git checkout -b feature/my-new-feature ``` 2. Commit your changes: + ```bash git add . git commit -m "feat: add support for X" ``` 3. Push and open a pull request: + ```bash git push origin feature/my-new-feature ``` diff --git a/.github/workflows/pr-lint.yml b/.github/workflows/pr-lint.yml index 510428b..2abb30c 100644 --- a/.github/workflows/pr-lint.yml +++ b/.github/workflows/pr-lint.yml @@ -1,5 +1,7 @@ --- +# yamllint disable rule:line-length # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json +# yamllint enable rule:line-length name: PR Lint # yamllint disable-line rule:truthy @@ -20,10 +22,12 @@ jobs: name: PR Lint runs-on: ubuntu-latest permissions: - contents: write # only for delete-branch option + contents: write # only for delete-branch option issues: write pull-requests: write statuses: write steps: - - uses: ivuorinen/actions/pr-lint@edb5db7b564801bc35bcd5b7667c185760d05fdd # 25.4.28 + # yamllint disable rule:line-length + - uses: ivuorinen/actions/pr-lint@edb5db7b564801bc35bcd5b7667c185760d05fdd # 25.4.28 + # yamllint enable rule:line-length diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml index cd3d885..5121188 100644 --- a/.github/workflows/python-tests.yml +++ b/.github/workflows/python-tests.yml @@ -1,10 +1,12 @@ +--- name: Python tests +# yamllint disable-line rule:truthy on: push: - branches: [ main, master ] + branches: [main, master] pull_request: - branches: [ main, master ] + branches: [main, master] permissions: read-all @@ -14,10 +16,12 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + # yamllint disable-line rule:line-length + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Set up Python - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 + # yamllint disable-line rule:line-length + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: "3.13.2" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a3a4928..1cc9c66 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,39 +1,40 @@ +--- repos: -- repo: https://github.com/asottile/pyupgrade - rev: v3.19.1 - hooks: - - id: pyupgrade - args: [--py3-plus] -- repo: https://github.com/astral-sh/ruff-pre-commit - rev: "v0.11.5" - hooks: - - id: ruff - args: ["--fix"] - - id: ruff-format -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v5.0.0 - hooks: - - id: check-ast - - id: check-builtin-literals - - id: check-docstring-first - - id: check-executables-have-shebangs - - id: check-json - - id: check-merge-conflict - - id: check-shebang-scripts-are-executable - - id: check-toml - - id: check-yaml - - id: debug-statements - - id: detect-aws-credentials - - id: double-quote-string-fixer - - id: end-of-file-fixer - - id: mixed-line-ending - - id: name-tests-test - - id: no-commit-to-branch - - id: requirements-txt-fixer - - id: trailing-whitespace -- repo: https://github.com/christophmeissner/pytest-pre-commit - rev: 1.0.0 - hooks: - - id: pytest - pass_filenames: false - always_run: true + - repo: https://github.com/asottile/pyupgrade + rev: v3.19.1 + hooks: + - id: pyupgrade + args: [--py3-plus] + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: "v0.11.5" + hooks: + - id: ruff + args: ["--fix"] + - id: ruff-format + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: check-ast + - id: check-builtin-literals + - id: check-docstring-first + - id: check-executables-have-shebangs + - id: check-json + - id: check-merge-conflict + - id: check-shebang-scripts-are-executable + - id: check-toml + - id: check-yaml + - id: debug-statements + - id: detect-aws-credentials + - id: double-quote-string-fixer + - id: end-of-file-fixer + - id: mixed-line-ending + - id: name-tests-test + - id: no-commit-to-branch + - id: requirements-txt-fixer + - id: trailing-whitespace + - repo: https://github.com/christophmeissner/pytest-pre-commit + rev: 1.0.0 + hooks: + - id: pytest + pass_filenames: false + always_run: true diff --git a/README.md b/README.md index 7bab427..0401d7a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# aeonview + ```markdown # _) # _` | -_) _ \ \ \ \ / | -_) \ \ \ /