godotengine / godotengine/godot-docs

Document the management of `.csproj` files in .NET projects

Open
#9,696 0 comments 1 reaction 0 assignees View on GitHub
content:new page enhancement topic:dotnet
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

This is a follow-up to the following PR.
- godotengine/godot#94939

As discussed, it would be nice to write a documentation page about what Godot does (and doesn't do) when it comes to `.csproj` files. I personally think the following points should be included.
- Explicitly state that users can manage the content of their `.csproj` file as they see fit.
- Explain that Godot will update the `Sdk` version if it needs to, but that should be the only thing it ever overwrites.
- Explain the content of the default `.csproj` file, and what users should not touch to have their project working properly in Godot.
- Explain how to define constants, since it is a very common use case. Maybe even note that when editing as text, one should do `$(DefineConstants);FOO` and not `FOO` to avoid writing over the Godot constants.
- Add a link to the official documentation (not sure which page would be best, maybe [this one](https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild?view=vs-2022#project-file)).

I think this should probably be done in a brand-new page under the C# manual section.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.