Merge pull request #29 from dcronqvist/multi-version

Add version compatiblity matrix and PR templates

.github/pull_request_template/dev_template.md

@@ -0,0 +1,15 @@
+## Description
+<!-- Provide a clear and concise description of the changes introduced by this PR. Include the purpose and context for these changes. -->
+
+### Type of Change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] Tests have been added/updated to cover new functionality.
+- [ ] Documentation has been updated for all new changes (e.g., usage examples, API documentation).
+

.github/pull_request_template/master_template.md

@@ -0,0 +1,10 @@
+# Release vX.Y.Z
+
+<!-- Include a description of what is breaking/new/patched in this release. -->
+
+## Checklist for a release PR
+
+- [ ] Version compatibility matrix has been updated.
+- [ ] Tests have been added/updated to cover new functionality.
+- [ ] Documentation has been updated for all new changes (e.g., usage examples, API documentation).
+

docs/docs/essentials/representation-model.md

@@ -6,4 +6,12 @@ Certain properties throughout the representation model are marked as *optional*
 
 - Properties that make use of the [required](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/required) keyword must be present in the file, otherwise an error will be raised.
 - Properties that have default values will use the default value if the property is not present in the file, and are not marked as required or optional since you must not provide a value for them.
-- Properties that are wrapped in <xref:DotTiled.Optional`1> may or may not be present in the file, and have no default value.
+- Properties that are wrapped in <xref:DotTiled.Optional`1> may or may not be present in the file, and have no default value.
+
+## Version compatibility
+
+The representation model is designed to be compatible with the latest version of Tiled. This means that it may not be able to read files from older versions of Tiled, or files that use features that are not yet supported by the representation model. However, here is a table of which versions of Tiled are supported by which versions of DotTiled.
+
+| Tiled version | Compatible DotTiled version(s) |
+|---------------|--------------------------------|
+| 1.11          | 0.1.0                          |

src/DotTiled/README.md

@@ -14,7 +14,7 @@ Other similar libraries exist, and you may want to consider them for your projec
 
 |**Comparison**|**DotTiled**|[TiledLib](https://github.com/Ragath/TiledLib.Net)|[TiledCSPlus](https://github.com/nolemretaWxd/TiledCSPlus)|[TiledSharp](https://github.com/marshallward/TiledSharp)|[TiledCS](https://github.com/TheBoneJarmer/TiledCS)|[TiledNet](https://github.com/napen123/Tiled.Net)|
 |---------------------------------|:-----------------------:|:--------:|:-----------:|:----------:|:-------:|:------:|
-| Actively maintained             |            ✅          |     ✅   |     ✅      |      ❌   |    ❌  |   ❌   |
+| Actively maintained             |            ✅          |     ✅   |     ❌      |      ❌   |    ❌  |   ❌   |
 | Benchmark (time)*               |           1.00          |   1.83   |     2.16    |      -     |    -    |    -   |
 | Benchmark (memory)*             |           1.00          |   1.43   |     2.03    |      -     |    -    |    -   |
 | .NET Targets                    | `net8.0` | `net8.0` |`netstandard2.1`|`netstandard2.0`|`netstandard2.0`|`net45`|