Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 2.36 KB
Raw

Contributing

Contributing to gir.core is very easy. If there is something wrong or missing just open an issue to get in contact.

Contributing code is very welcome, too. Either look for issues with the enhancement Tag and get in contact or just create a pull request containing the improvements.

If a pull request contributes new code, please be aware of the project's license. For easy adoption of the code please adhere to the following coding guidelines.

Coding Guidelines

The following guidelines aim to provide a framework to write code in a consistent style. If the following guidelines are incomplete the official C# coding conventions and framework design guidelines apply.

Comments

  • Begin a comment with an uppercase letter.
  • End a comment with a period.
  • Insert a space before starting the comment text.

Implicitly Typed Local Variables

  • Use var for variables if the type of the right hand side expression is obvious or not important.

New Operator

  • Use object initializers to create objects.

Members

Members include: Properties, constructors, methods, fields, events.

  • Call static members by using the class name: MyClass.MyMember.
  • Fields are only allowed to be private. If needed create a property.

Naming

  • Don't use Hungarian notation.
  • Don't use abbreviations as part of identifier names.
  • Use PascalCase for all public / protected members.
  • Use PascalCase for all types.
  • Use camelCase for all parameter names.
  • Use _camelCase for all private instance fields.

Structure of *.cs files

Partial classes are allowed do split the content of a class into well named files with the following notation: Class1.Part1.cs

Implementations which are external to the concrete class must be either in a separate #region or a separate partial class (e.g. interface implementations).

Inside a source file the structure is like:

  1. Private fields (enclosed in a region tag #region Fields)
  2. Properties (enclosed in a region tag #region Properties)
  3. Constructors (enclosed in a region tag #region Constructors)
  4. Methods (enclosed in a region tag #region Methods)

Access modifiers

All access modifiers should explicitly stated in the code.