Before this change, there was three different bug reporting guides:
- [“Filing an issue on GitHub”][1]
- [“Reporting bugs”][2]
- [The issue template][3]
This commit:
1. makes sure that [the issue template][3] contains all of the same
information that [“Filing an issue on GitHub”][1] and
[“Reporting bugs”][2] did and
2. makes [“Reporting bugs”][2] simply tell users to fill out the
template.
The goal of this change is to make reporting bugs easier. This change
accomplishes that goal by presenting bug reporters with all of the
information they need to know on the bug reporting page itself.
This commit partially implements this proposal:
<https://github.com/godotengine/godot-proposals/discussions/4083>
[1]: https://docs.godotengine.org/en/stable/community/contributing/ways_to_contribute.html#filing-an-issue-on-github
[2]: ./CONTRIBUTING.md#reporting-bugs
[3]: ./.github/ISSUE_TEMPLATE/bug_report.yml
As announced in https://godotengine.org/article/godot-4-will-discontinue-visual-scripting,
Godot maintainers have agreed to discontinue the current implementation of
our VisualScript language.
The way it had been designed was not user-friendly enough and we did not
succeed in improving its usability to actually make it a good low-code
solution for users who need one.
So we prefer to remove it for Godot 4.0 and leave the door open for new,
innovative ideas around visual scripting, to be developed as plugins or
extensions now that Godot provides sufficient functionality for this
(notably via GDExtension and the godot-cpp C++ bindings).
The current module has been moved to a dedicated repository (with full Git
history extracted with `git filter-branch`):
https://github.com/godotengine/godot-visual-script
It can still be compiled as a C++ module (for now, but will likely require
work to be kept in sync with the engine repository), but our hope is that
contributors will port it to GDExtension (which is quite compatibile with
the existing C++ module code when using the godot-cpp C++ bindings).
Third-party file hosts can have their files expire or be removed
by the owner. In comparison, GitHub attachments are more resilient.
This also fixes the link to create a bug report.
Many contributors don't have a Mono setup available, especially if
compiling from source is required.
Minimal reproduction projects in GDScript are also better at isolating
the actual bug, since it automatically rules out any possible C#
integration issues.
- Improve the bug reporting guidelines for readability.
- Make some guidelines more strictly applied in the interest of
bug report quality.
- Mention that feature proposals should now be opened on the
Godot Proposals repository.
- Update the Git commit message guide to be easier to follow.
- Fix warnings reported by markdownlint.
CONTRIBUTING.md would use the phrase "those guidelines" to introduce a
list. In general, the word "these" is used to refer to something that is
being introduced or has recently been introduced, and "those" is used to
refer to something that had been previously introduced.
This change also makes CONTRIBUTING.md consistent with the
documentation. The documentation guidelines at
https://docs.godotengine.org/en/latest/community/contributing/documentation_guidelines.html
use "these" to introduce a list and its singular form, "this", to
introduce items.
