Skip to content

Commit 97f0633

Browse files
authored
🎨 fix header level (#826)
1 parent d579cba commit 97f0633

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

‎docs/contributing_guide.rst‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ How to Contribute Code
44
This document describes how the BO4E Python implementation is written and what to watch out for.
55

66
Technical Setup in your IDE
7-
===========================
7+
---------------------------
88

99
We're using tox. Please follow the instructions in our `Python Template Repository <https://github.com/Hochfrequenz/python_template_repository#how-to-use-this-repository-on-your-machine>`_. Feel free to open an issue if you run into any kind of problems.
1010

1111
Coding Style and Guidelines
12-
===========================
12+
---------------------------
13+
1314

1415
General Rules
15-
-------------
16+
^^^^^^^^^^^^^
1617

1718
- We use (and enforce in the CI):
1819
- black for formatting
@@ -29,7 +30,7 @@ General Rules
2930
- We use ``snake_case`` internally but serialize as ``camelCase`` by overriding the ``data_key`` property of the schema fields.
3031

3132
How to Define an ENUM?
32-
----------------------
33+
^^^^^^^^^^^^^^^^^^^^^^
3334

3435
All Enums inherit from ``bo4e.enum.StrEnum``. The latter is just a usual Enum with a ``str`` mixin (see `the official docs <https://docs.python.org/3/library/enum.html?highlight=strenum#others>`_ for details). This allows us to precisely define how an enum value will be serialized. All enum values have UPPER_CASE names.
3536

@@ -54,7 +55,7 @@ All Enums inherit from ``bo4e.enum.StrEnum``. The latter is just a usual Enum wi
5455
# this typically happens for annoying enum values that contains "-" or start with digits
5556
5657
How to Define COMs or BOs
57-
-------------------------
58+
^^^^^^^^^^^^^^^^^^^^^^^^^
5859

5960
All COMponents inherit from ``bo4e.com.com.COM``. All Business Objects inherit from ``bo4e.bo.geschaeftsobjekt.Geschaeftsobjekt``.
6061

@@ -100,7 +101,7 @@ For data validation and de/serialization we use `pydantic <https://pydantic-docs
100101
# You don't need to be a perfect programmer to contribute to bo4e :)
101102
102103
Unittests
103-
---------
104+
^^^^^^^^^
104105

105106
Ideally provide unittests that show:
106107

@@ -114,12 +115,12 @@ Ideally provide unittests that show:
114115
Therefore, copy one of the existing "roundtrip" tests, see f.e. ``TestTarifeinschraenkung``.
115116

116117
Pull Request
117-
============
118+
------------
118119

119120
Open a Pull Request against the main/default branch of this repository. We'd appreciate if you allowed maintainer edits.
120121

121122
Release Workflow
122-
================
123+
----------------
123124

124125
- Check with tox all tests and linting: ``tox``
125126
- Check with tox if the packaging works fine: ``tox -e test_packaging``

0 commit comments

Comments
 (0)