Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/instructions/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@


Project instructions

To add a new dependency for the `fmuloader` project, you can use the following command in your terminal:

```bash
uv add <dependency-name>
```

To add a new development dependency for the `fmuloader` project, you can use the following command in your terminal:

```bash
uv add --dev <dependency-name>
```

To run the tests for the `fmuloader` project, you can use the following command in your terminal:

```bash
uv run pytest
```
58 changes: 58 additions & 0 deletions .github/instructions/python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
description: 'Python coding conventions and guidelines'
applyTo: '**/*.py'
---

# Python Coding Conventions

## Python Instructions

- Write clear and concise comments for each function.
- Ensure functions have descriptive names and include type hints.
- Provide docstrings following PEP 257 conventions.
- Use the `typing` module for type annotations (e.g., `List[str]`, `Dict[str, int]`).
- Break down complex functions into smaller, more manageable functions.

## General Instructions

- Always prioritize readability and clarity.
- For algorithm-related code, include explanations of the approach used.
- Write code with good maintainability practices, including comments on why certain design decisions were made.
- Handle edge cases and write clear exception handling.
- For libraries or external dependencies, mention their usage and purpose in comments.
- Use consistent naming conventions and follow language-specific best practices.
- Write concise, efficient, and idiomatic code that is also easily understandable.

## Code Style and Formatting

- Follow the **PEP 8** style guide for Python.
- Maintain proper indentation (use 4 spaces for each level of indentation).
- Ensure lines do not exceed 79 characters.
- Place function and class docstrings immediately after the `def` or `class` keyword.
- Use blank lines to separate functions, classes, and code blocks where appropriate.

## Edge Cases and Testing

- Always include test cases for critical paths of the application.
- Account for common edge cases like empty inputs, invalid data types, and large datasets.
- Include comments for edge cases and the expected behavior in those cases.
- Write unit tests for functions and document them with docstrings explaining the test cases.

## Example of Proper Documentation

```python
def calculate_area(radius: float) -> float:
"""
Calculate the area of a circle given the radius.

Parameters:
-----------
radius (float): The radius of the circle. Must be a non-negative value.

Returns:
-----------
float: The area of the circle, calculated as π * radius^2.
"""
import math
return math.pi * radius ** 2
```
Loading