Skip to content

Commit 5fd3c3d

Browse files
chore(deps): bump from template
1 parent b6ffa06 commit 5fd3c3d

8 files changed

Lines changed: 15 additions & 24 deletions

File tree

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_commit: v0.5.12
1+
_commit: v0.5.13
22
_src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
33
author_email: helmuthva@gmail.com
44
author_github_username: helmut-hoffer-von-ankershoffen

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Always conform to the coding styles defined in CODE-STYLE.md in the root
1+
Always conform to the coding styles defined in CODE_STYLE.md in the root
22
directory of this repository when generating code.
33

44
Learn about tools to use in CONTRIBUTING.md in the root directory of this

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
"github.copilot.chat.edits.temporalContext.enabled": true,
5858
"github.copilot.chat.codeGeneration.instructions": [
5959
{
60-
"file": "CODE-STYLE.md"
60+
"file": "CODE_STYLE.md"
6161
},
6262
{
6363
"file": "CONTRIBUTING.md"

CODE-STYLE.md renamed to CODE_STYLE.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
1-
---
2-
title: Code Style
3-
author: Helmut Hoffer von Ankershoffen (@helmut-hoffer-von-ankershoffen)
4-
audience: all
5-
status: draft
6-
created: 2025-03-16
7-
updated: 2025-03-16
8-
tags: [style, code, python, typescript]
9-
description: |
10-
This document describes the code style used in [oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template) and derivatives. It defines
11-
strict requirements to be followed by all contributors - humans and agents - to
12-
ensure consistency and readability across the codebase.
13-
---
14-
151
# Code Style
162

3+
Author: Helmut Hoffer von Ankershoffen (@helmut-hoffer-von-ankershoffen )
4+
Status: Draft
5+
Created: 2025-03-16
6+
Updated: 2025-03-16
7+
178
This document describes the code style used in
189
[oe-python-templat](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
1910
and derivatives. It defines strict requirements to be followed by all
@@ -121,8 +112,6 @@ We generate the final documentation using Sphinx and publish it to readthedocs.
121112
We use [pytest](https://docs.pytest.org/en/stable/) for testing Python code.
122113

123114
- Tests are defined in the `tests/` directory
124-
- Tests are named test__.py and classes are named Test_
125-
- Test functions are named test_*
126115
- We use pytest fixtures to set up test data and state
127116
- We leverage several pytest plugins:
128117
- `pytest-asyncio` for testing async code

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ uv run nox -s update_from_template
139139

140140
## Pull Request Guidelines
141141

142-
- Before starting to write code read the [CODE-STYlE.md](CODE-STYLE.md) document for mandatory coding style
142+
- Before starting to write code read the [code style guide](CODE_STYLE.md) document for mandatory coding style
143143
guidelines.
144144
- **Pre-Commit Hooks:** We use pre-commit hooks to ensure code quality. Please install the pre-commit hooks by running `uv run pre-commit install`. This ensure all tests, linting etc. pass locally before you can commit.
145145
- **Squash Commits:** Before submitting a pull request, please squash your commits into a single commit.

SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ We follow these security best practices:
4949

5050
We promote security awareness among contributors and users
5151

52-
- We indicate security as a priority in our mandatory
53-
[CODE-STYLE.md](CODE-STYLE.md) document, to be followed by human and agentic
54-
contributors.
52+
- We indicate security as a priority in our
53+
[code style guide](CODE_STYLE.md), to be followed by human and agentic
54+
contributors as mandatory
5555
- We publish our security posture in SECURITY.md (this document), encouraring
5656
users to report vulnerabilities.
5757

docs/source/code-style.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. mdinclude:: ../../CODE_STYLE.md

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@
1414
api_v1
1515
api_v2
1616
reference
17-
release-notes
1817
security
18+
release-notes
1919
contributing
20+
code-style
2021

2122
.. sidebar-links::
2223
:caption: Links

0 commit comments

Comments
 (0)