From 373cdc991e2f76fa670545aa71a4c5cc5c7ba766 Mon Sep 17 00:00:00 2001 From: Daniel Cronqvist Date: Sat, 7 Sep 2024 20:55:05 +0200 Subject: [PATCH 1/3] Fix maintained status in NuGet README --- src/DotTiled/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DotTiled/README.md b/src/DotTiled/README.md index a834a39..cd16fe2 100644 --- a/src/DotTiled/README.md +++ b/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`| From 914a667c35fd8409e97ce0b61b5d4d1dd0dfbb18 Mon Sep 17 00:00:00 2001 From: Daniel Cronqvist Date: Sat, 7 Sep 2024 21:21:16 +0200 Subject: [PATCH 2/3] Add version compatibility matrix to docs --- docs/docs/essentials/representation-model.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/docs/essentials/representation-model.md b/docs/docs/essentials/representation-model.md index 94815a4..561b032 100644 --- a/docs/docs/essentials/representation-model.md +++ b/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 may or may not be present in the file, and have no default value. \ No newline at end of file +- Properties that are wrapped in 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 | \ No newline at end of file From 40106b54725607a2c0d271f606759af09e9a72f2 Mon Sep 17 00:00:00 2001 From: Daniel Cronqvist Date: Sat, 7 Sep 2024 21:39:48 +0200 Subject: [PATCH 3/3] Add different PR templates to make sure no release work is missed, and dev PRs are actually filled with useful information --- .github/pull_request_template/dev_template.md | 15 +++++++++++++++ .github/pull_request_template/master_template.md | 10 ++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .github/pull_request_template/dev_template.md create mode 100644 .github/pull_request_template/master_template.md diff --git a/.github/pull_request_template/dev_template.md b/.github/pull_request_template/dev_template.md new file mode 100644 index 0000000..128b591 --- /dev/null +++ b/.github/pull_request_template/dev_template.md @@ -0,0 +1,15 @@ +## Description + + +### 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). + diff --git a/.github/pull_request_template/master_template.md b/.github/pull_request_template/master_template.md new file mode 100644 index 0000000..28ba2d5 --- /dev/null +++ b/.github/pull_request_template/master_template.md @@ -0,0 +1,10 @@ +# Release vX.Y.Z + + + +## 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). +