Skip to content

Commit

Permalink
Merge pull request #214 from yaurthek/fix-contrib-guide-typos
Browse files Browse the repository at this point in the history
Fix typos in CONTRIBUTING.md
  • Loading branch information
aaubry authored Nov 2, 2016
2 parents b758a29 + 9556071 commit e2a7fa6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ All contributions should be submitted as pull requests.
1. Always add one or more **unit tests** that prove that the feature / fix you are submitting is working correctly.

1. Please **describe the motivation** behind the pull request. Explain what was the problem / requirement. Unless the implementation is self-explanatory, also describe the solution.
* Of course, there's no need to too verbose. Usually one or two lines will be enough.
* Of course, there's no need to be too verbose. Usually one or two lines will be enough.

## Project organization

Expand Down Expand Up @@ -57,14 +57,14 @@ There are a few differences between the various target platforms,
mainly in the reflection API. In order to adapt the code to each platform,
`#if ... #endif` sections are used. When possible, such sections should be placed
in the `Helpers/Portability.cs` file. An effective technique is to define an extension
method that is used tourough the code, and has different implementations depending
method that is used through the code, and has different implementations depending
on the build variables.

## AOT compatibility

Some platforms - such as IOS - forbid dynamic code generation. This prevents Just-in-Time compilation (JIT) from being used. In those cases, one can use Mono's Ahead-of-Time compilation (AOT). This results on a precompiled assembly that does not rely on JIT. There are [some limitations](http://www.mono-project.com/docs/advanced/aot/#limitation-generic-interface-instantiation) however, most of them related to usage of generics.

In order to ensure that YamlDotNet is compatible with AOT compilation, an automatic test has been created that runs on every commit on [Travis CI](https://travis-ci.org/aaubry/YamlDotNet). That test exercises the serialize and deserializer to help identify AOT-related problems.
In order to ensure that YamlDotNet is compatible with AOT compilation, an automatic test has been created that runs on every commit on [Travis CI](https://travis-ci.org/aaubry/YamlDotNet). That test exercises the serializer and deserializer to help identify AOT-related problems.

## Coding style

Expand Down

0 comments on commit e2a7fa6

Please sign in to comment.