Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (46 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 1.09 KB

Contributing Guidelines

Prerequisites

To contribute, you will need the following:

  • A decent knowledge of C#
  • A decent knowledge of WinForms (if working with the interface)
  • A decent knowledge of how to use an IDE.
  • Debug and test your code before contributing.
  • Visual Studio IDE (2019 or 2022)
    • .NET Desktop Development
    • .NET Core 5.0

Code Format

Our code formatting is very specific, and it is recommended to follow these guidelines.

If Statements

If statements should follow the following format.

if(Equation)
{
   Something();
   SomethingElse(true);
}
else
{
   SomethingElse();
   Something(false);
}

Single Code Lines

When coming across a single code statement, you should follow the following format.

public static void Example
{
  CheckSomething();
}

Try/Catch Statements

When using a try/catch statement, use the following code. If you are debugging, it is recommended to put a Debug.Print in the statements while testing.

try
 {
    DoSomething();
 }
 catch(Exception ex)
 {
    Error();
 }