Skip to content

Commit 4c58e9e

Browse files
committed
Fixing the missing coverage report
1 parent ce52092 commit 4c58e9e

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,27 @@ tox -e py39 # For Python 3.9
8686
- Follow Google style for docstrings
8787
- Keep the README.md and other documentation up to date
8888

89+
### Documentation Requirements
90+
91+
- Use docstrings for all public modules, functions, classes, and methods
92+
- Follow Google style for docstrings
93+
- Keep the README.md and other documentation up to date
94+
95+
#### Required Extensions
96+
97+
When contributing to documentation, please note that we use the following extensions:
98+
99+
- **Mermaid**: For creating diagrams and visualizations in markdown. All architecture and flow diagrams should be written using Mermaid.
100+
```mermaid
101+
graph TD
102+
A[Process Start] --> B[Process End]
103+
```
104+
105+
To preview Mermaid diagrams locally, you can:
106+
- Use VS Code with the "Markdown Preview Mermaid Support" extension
107+
- Use any Markdown editor that supports Mermaid rendering
108+
- Preview on GitHub, which has native Mermaid support
109+
89110
## Pull Request Process
90111

91112
1. Update the README.md with details of changes to the interface, if applicable.

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ commands_pre =
1818
rm get_helm.sh; \
1919
fi'
2020
commands =
21-
# Run all tests with coverage
22-
pytest -v tests/
21+
# Run all tests with coverage and generate XML report
22+
pytest -v --cov=helm_values_manager --cov-report=xml tests/

0 commit comments

Comments
 (0)