GitHub Copilot templates for Level 1: Building formula

[GerjanDorgelo]

In order to build formula for Blueprints with a fast pace, here are 8 templates that can be used such that GitHub Copilot builds the Formula and tests with very high accuracy.

Three types of formula are handled:

1. Basic equations that look like A = w * h
   template_basic_equation.txt -> template_basic_equation_tests.txt

2. Comparisons that look like V_Ed < V_Rd
   template_comparison.txt -> template_comparison_tests.txt

3. Casus that have multiple if/else statements, usually containing a bracket {
   template_casus.txt -> template_casus_tests.txt

Then two commands for efficient copilot usage are presented:

1. One that generates the formula copilot_command_for_formula.txt
2. One that generates the tests copilot_command_for_tests.txt

Best practice for making formula:

1. Make new formula file and copy the correct template in the file
2. Copy the copilot command, paste it in the Copilot Inline chat (ctrl+a -> ctrl+i) and extend it with
   a. the formula name (e.g. 6.41)
   b. chapter (e.g. 6.4.3(3))
   c. the equation itself (e.g. W_1 = c_1^2 / 2 + c_1 * c_2 + 4 * c_2 * d + 16 * d^2 + 2 * pi * d * c_1)
   d. the variable description which often can be copy pasted (e.g. where c_1 is the column dimension ...)
3. Press enter and check copilot result

Best practice for making tests:

1. Make new formula file and copy the right template in the file
2. Copy the copilot command and extend it with formula 6.40 (should automatically link to right file with the # in front)
3. Press enter, check copilot result and run pytests

Common mistakes by Copilot:

• Units
• Chapter numbers or EuroCode documents
• Manually calculated result in the test
• Proper usage of LessOrEqualToZeroError vs NegativeValueError

[SZeltaat]

Suggestion for command instead of current text regarding type hints from type_alias.py:
Import the necessary typehinting with type alias units found in type_alias.py and remove the unused imported type aliases.

[GerjanDorgelo]

implemented in next release

[SZeltaat]

@GerjanDorgelo Have you seen this new idea of prompt files?

We can include prompt files inside the project (in the .github/prompts directory) and reference it in the copilot editor.
I think it's a good idea to implement. This way we can all improve the templates over time and also skip the manual copy-pasting

https://youtu.be/C95drFKy4ss?t=290&si=38rzFbnea0kmWHLE

[GerjanDorgelo]

woah this is amazing! let me work on that later today! 😲

[GerjanDorgelo]

as per #480, we can now select in Agent mode :)