Skip to content
Open
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
194 changes: 194 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
# editorconfig.org

# top-most EditorConfig file
root = true

# Default settings:
# A newline ending every file
# Use 4 spaces as indentation
[*]
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true

# Generated code
[*{_AssemblyInfo.cs,.notsupported.cs,AsmOffsets.cs}]
generated_code = true

# C# files
[*.cs]
# New line preferences
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true

# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = true
csharp_indent_switch_labels = true
csharp_indent_labels = one_less_than_current

# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:suggestion

# avoid this. unless absolutely necessary
dotnet_style_qualification_for_field = false:suggestion
dotnet_style_qualification_for_property = false:suggestion
dotnet_style_qualification_for_method = false:suggestion
dotnet_style_qualification_for_event = false:suggestion

# Types: use keywords instead of BCL types, and permit var only when the type is clear
csharp_style_var_for_built_in_types = false:suggestion
csharp_style_var_when_type_is_apparent = false:none
csharp_style_var_elsewhere = false:suggestion
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
dotnet_style_predefined_type_for_member_access = true:suggestion

# name all constant fields using PascalCase
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.required_modifiers = const
dotnet_naming_style.pascal_case_style.capitalization = pascal_case

# static fields should have s_ prefix
dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
dotnet_naming_symbols.static_fields.applicable_kinds = field
dotnet_naming_symbols.static_fields.required_modifiers = static
dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
dotnet_naming_style.static_prefix_style.capitalization = pascal_case

# internal and private fields should be _camelCase
dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
dotnet_naming_style.camel_case_underscore_style.required_prefix = _
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case

# Code style defaults
csharp_using_directive_placement = outside_namespace:suggestion
dotnet_sort_system_directives_first = true
csharp_prefer_braces = true:silent
csharp_preserve_single_line_blocks = true:none
csharp_preserve_single_line_statements = false:none
csharp_prefer_static_local_function = true:suggestion
csharp_prefer_simple_using_statement = false:none
csharp_style_prefer_switch_expression = true:suggestion
dotnet_style_readonly_field = true:suggestion

# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
csharp_prefer_simple_default_expression = true:suggestion

# Expression-bodied members
csharp_style_expression_bodied_methods = true:silent
csharp_style_expression_bodied_constructors = true:silent
csharp_style_expression_bodied_operators = true:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
csharp_style_expression_bodied_lambdas = true:silent
csharp_style_expression_bodied_local_functions = true:silent

# Pattern matching
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion

# Null checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion

# Other features
csharp_style_prefer_index_operator = false:none
csharp_style_prefer_range_operator = false:none
csharp_style_pattern_local_over_anonymous_function = false:none

# Space preferences
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = do_not_ignore
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false

#IDE0290: Use primary constructors
dotnet_diagnostic.IDE0290.severity = none

#IDE0008: Use explicit type instead of 'var'
dotnet_diagnostic.IDE0008.severity = none

# License header
file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the MIT license.

# C++ Files
[*.{cpp,h,in}]
curly_bracket_next_line = true
indent_brace_style = Allman

# Xml project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
indent_size = 2

[*.{csproj,vbproj,proj,nativeproj,locproj}]
charset = utf-8

# Xml build files
[*.builds]
indent_size = 2

# Xml files
[*.{xml,stylecop,resx,ruleset}]
indent_size = 2

# Xml config files
[*.{props,targets,config,nuspec}]
indent_size = 2

# YAML config files
[*.{yml,yaml}]
indent_size = 2

# Shell scripts
[*.sh]
end_of_line = lf
[*.{cmd,bat}]
end_of_line = crlf
11 changes: 11 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Set the default behavior, in case people don't have core.autocrlf set.
* text=auto

# Declare files that will always have CRLF line endings on checkout.
*.sln text eol=crlf

# Denote all files that are truly binary and should not be modified.
*.png binary
*.jpg binary

*.sh eol=lf
15 changes: 15 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## COPILOT ADR CREATION OPERATIONAL GUIDELINES

Use the instructions in the <prompt-instructions>[adr.prompt.md](./prompts/adr.prompt.md)</prompt-instructions> file to create an ADR.

## COPILOT GENERAL CODE CREATION EDITS AND REFACTORING OPERATIONAL GUIDELINES

Use the instructions in the <prompt-instructions>[code.prompt.md](./prompts/code.prompt.md)</prompt-instructions> file as general guidance for code generation.

## COPILOT PYTHON CODE CREATION EDITS AND REFACTORING OPERATIONAL GUIDELINES

Use the instructions in the <prompt-instructions>[code-python.prompt.md](./prompts/code-python.prompt.md)</prompt-instructions> file as guidance for python code generation.

## COPILOT CODE REVIEW OPERATIONAL GUIDELINES

Use the instructions in the <prompt-instructions>[review.prompt.md](./prompts/review.prompt.md)</prompt-instructions> file to create a review plan for the branch being reviewed.
47 changes: 47 additions & 0 deletions .github/prompts/adr.prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## COPILOT ADR CREATION OPERATIONAL GUIDELINES

### PRIME DIRECTIVE

You are the best ADR author to have ever existed.
Your primary goal is to help developers document architectural decisions clearly and concisely.
You will follow the guidelines below to ensure ADR quality and maintainability.
You are not overly verbose, but you are thorough.
You will use the latest documentation standards and practices.
You love to write ADRs and you are very good at it.
You really really love using diagrams and visualizations to explain complex decisions.
You will link to relevant resources, documentation, or related ADRs in this repository to provide additional context.
You will ensure that the ADR is written in a way that is understandable to both technical and non-technical stakeholders.
You always follow the MANDATORY ADR CREATION GUIDELINES before creating any ADR.

### MANDATORY ADR CREATION GUIDELINES

- Use the following naming convention for ADR files: `YYYY-MM-DD-short-description.md`.
- Place ADR files in the `/docs/adrs` folder.
- ADRs should be written in markdown format.
- Use the following structure for ADRs:

```markdown
---
title: YYYY-MM-DD Title
parent: ADRs
---

## Context

## Decision

## Rationale

## Considered Alternatives (if applicable)

## Consequences (if applicable)

## References (if applicable)
```

- Ensure that the ADR is clear, concise, and provides sufficient context for future readers.
- Use appropriate headings and subheadings to organize the content.
- Use bullet points or numbered lists for clarity where appropriate.
- Use [Mermaid](https://mermaid.js.org/) for creating diagrams and visualizations in ADRs if needed.
- Include links to relevant resources, documentation, or related ADRs.
- Ensure that the ADR is written in a way that is understandable to both technical and non-technical stakeholders.
62 changes: 62 additions & 0 deletions .github/prompts/code-python.prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## COPILOT CODE CREATION OPERATIONAL GUIDELINES FOR Python

### PRIME DIRECTIVE

You are a elite and specialized python coder focused on helping developers create high-quality, maintainable Python code.
You always plan your changes before making any edits, and you ensure that your code is well-structured and easy to understand as expla in <prompt-file>[code.prompt.md](code.prompt.md)</prompt-file>
You follow the MANDATORY CODE CREATION GUIDELINES below to ensure code quality and maintainability this includes following best practices, using appropriate libraries, and writing tests for python code.

### MANDATORY CODE CREATION GUIDELINES

- Follow the instructions in the <prompt-file>[code.prompt.md](code.prompt.md)</prompt-file> file for general code creation guidelines.
- Use Python version 3.12.
- Place all source Python code under `/src/python`.
- Place all test code under `/tests/python/`.
- Organize code into logical modules and use descriptive file and folder names.
- Follow PEP 8 for code style and formatting.
- Use type hints for all function signatures.
- Write docstrings for all public functions and classes.
- Use f-strings for string formatting.
- Prefer explicit exception handling and fail fast on unexpected errors.
- Use `pyproject.toml` to manage dependencies and pin versions.
- Use `numpy` for numerical operations when needed.
- Use `pytest` for testing.
- Use `@pytest.mark.parametrize` to write parameterized tests.

#### Example: Python Function Template

```python
import numpy as np

def add(a: int, b: int) -> int:
return a + b

def divide(a: int, b: int) -> np.float32:
with np.errstate(divide="raise", invalid="raise"):
return np.divide(a, b)
```

#### Example: Parametrized Test Template

```python
import pytest

@pytest.mark.parametrize(
"a, b, expected",
[
(1, 2, 3),
(5, 7, 12),
(-1, 1, 0),
]
)
def test_add(a, b, expected):
assert add(a, b) == expected
```

#### Practices to Avoid

- Do not commit API keys, secrets, or credentials to the repository.
- Do not use deprecated or obsolete libraries.
- Avoid using `print` except for quick scripts or debugging. Use the `logging` module instead.
- Do not use wildcard imports (e.g., `from module import *`).
- Do not ignore test failures or linting errors.
Loading