Guidelines for contributing to the repo.
Adding a new unit or a new quantity is easy! See the detailed step-by-step guide:
We also want the person with the idea, suggestion or bug report to implement the change in code and get a sense of ownership for that piece of the library. This is to help grow the number of people that can contribute to the project and after someone new lands that first PR we often see more PRs from that person later.
- Match the existing code style, we generally stick to "Visual Studio defaults" and .NET Foundation Coding Guidelines
- If you use ReSharper there is a settings file that will take effect automatically
- There is an .editorconfig to help configure whitespace and C# syntax for your editor if it supports it
- Add the file header to new files you create
- Test class: Use
Testssuffix for the type you are testing, such asUnitSystemTests - Test method:
<method>_<condition>_<result>(Parse_AmbiguousUnits_ThrowsException) - If there are many tests for a single method, you can wrap those in an inner class named the same as the method and then you can skip that part of the test method names
For a fairly complete summary of the unit definition JSON schema, see Meter of Length. It has prefix units and multiple cultures.
For detailed conventions on conversion functions, abbreviations, base dimensions, and more, see Adding a New Unit.
Generally we try to name the units as what is the most widely used.
- Use prefix for country variants, such as
ImperialGallonandUsGallon
Note: We should really consider switching variant prefix to suffix, since that plays better with kilo, mega etc.. Currently we have units named KilousGallon and KiloimperialGallon, these would be better named KilogallonUs and KilogallonImperial.
See Docs/ for the full documentation index, including:
- Precision — conversion precision and test guidelines
- Adding Operator Overloads
- Serialization
- Upgrade Guides