Commit Graph

32 Commits

Author SHA1 Message Date
Kristoff ebb80c6975 Update godot documentation contribution link
Hey there, first time contributing and I'm in the middle of reading the contribution best practice, so sorry for any mistakes in this pull request. 

When clicking the **Contributing section** link under the **Contributors guidelines** title, this linked to the Godot *page not found* link.

I changed the link from `https://docs.godotengine.org/en/latest/contributing/ways_to_contribute.html` to `https://docs.godotengine.org/en/latest/contributing/how_to_contribute.html`.

Now, when a user clicks the link, it will redirect them to the start of the contribution documentation.
2024-07-20 20:51:11 -06:00
A Thousand Ships 6f99aeda04
Change suggestion in `CONTRIBUTING.md` to avoid spam
Having an issue tagged in a commit message spams the issue thread with
notifications, which can be especially noisy when new contributors make
a lot of updates or rebases.
2024-06-22 15:20:33 +02:00
Rémi Verschelde dff6752ac8
Cleanup various repository documentation files
- Reformat logo license as a plain text file.
- Fix outdated links or references to SFC or Visual Script.
- Tweak contents of `CONTRIBUTING.md` to highlight contributor docs more
  prominently, and make it easier to parse.
- Tweak formatting and contents in `thirdparty/README.md` for consistency.
2023-10-10 13:58:13 +02:00
Jason Yundt a6dc35e5cf Streamline and centralize bug reporting guides
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
2023-05-03 14:53:49 -04:00
Yuri Sizov 4c1f11944e Update all outdated online documentation links 2023-01-14 19:38:00 +03:00
Rémi Verschelde 6a86dfad29
Fix typos with codespell
Also includes #71080.

Co-authored-by: Psychpsyo <60073468+Psychpsyo@users.noreply.github.com>
2023-01-09 08:39:07 +01:00
Hugo Locurcio e032152494
Emphasize the importance of uploading a minimal reproduction project
The field is now required, but "N/A" can be manually entered if
the reproduction steps are trivial and don't require any project
files to be followed.
2022-11-17 21:46:41 +01:00
Aaron Franke 27b0f18275 Unify bits, arch, and android_arch into env["arch"]
Fully removes the `bits` option and adapts the code that relied on it.

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2022-08-25 11:19:20 +02:00
Rémi Verschelde b1f392c25e Remove VisualScript module for 4.0
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).
2022-08-24 12:08:17 +02:00
Hugo Locurcio 01c1667836
Recommend using GitHub attachments for minimal reproduction projects
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.
2022-02-06 12:33:40 +01:00
Rémi Verschelde 848f3bba7c Link to Godot Contributors Chat instead of IRC 2021-03-05 22:32:48 +01:00
Hugo Locurcio ea6ea8de86
Recommend minimal reproduction projects written in GDScript instead of C#
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.
2021-01-12 20:15:36 +01:00
Hugo Locurcio 8a84b3cfd3
Document contributing tests to Godot's C++ codebase
This partially addresses
https://github.com/godotengine/godot-proposals/issues/1586.
2020-09-30 16:29:23 +02:00
Hugo Locurcio 6d0e8f9fb7 Document the requirement to update the class reference when contributing
Documenting new additions has been an informal requirement for
a few months now. This makes it official.
2020-06-10 10:36:59 +02:00
Hugo Locurcio 7b5c502ba5
Improve `CONTRIBUTING.md` and update it to follow recent changes
- 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.
2020-02-01 09:57:32 +01:00
Rémi Verschelde 68eae6b6e9 Fix some URLs to use HTTPS when available 2020-01-29 02:48:10 +01:00
samHFIT e5f29308ba Minor English fix 2019-04-06 18:45:02 -04:00
Jason Yundt f8a22f0a90 Minor English fix
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.
2019-04-03 08:49:08 -04:00
Rémi Verschelde 40765302c6 Add some links to CONTRIBUTING.md 2018-11-20 14:27:35 +01:00
Rémi Verschelde 5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch
Fixes #23509.
2018-11-05 08:46:27 +01:00
Zaven Muradyan 172694ac4c Add useful links for contributors to CONTRIBUTING and README docs. 2018-10-13 22:59:52 -07:00
Martin Lindhe efe2558519 fix some typos 2017-11-28 16:18:22 +01:00
haugenmitch a41de1cc55 Formatting an unformatted hyperlink (#12226) 2017-10-19 12:53:11 +02:00
Gilles Roudiere 4f874e4f8e Formatting CONTRIBUTING.md to 80 colums
Added a little paragraph about how to contribute to Godot's translations
2017-05-30 11:28:58 +02:00
Maxwell Paul Brickner 984aeffd79 Changed a link from http to https
This is a really minor change. I just changed the link to the IRC channel login from http to https.

Thank you! ^ _ ^
2017-04-13 17:54:16 -04:00
Rémi Verschelde debeee56f7 Fix typos in source code using codespell
From https://github.com/lucasdemarchi/codespell
2017-03-24 21:45:31 +01:00
Rémi Verschelde 34c33648f2 Add information about dev communication channels 2017-01-11 14:27:12 +01:00
Rémi Verschelde 959683c3d8 Add missing commit title in the log example 2016-11-16 13:08:28 +01:00
Rémi Verschelde 15cdb5219c Add instructions about git commit log formatting 2016-11-16 13:01:01 +01:00
Rémi Verschelde c7ca6f31f7 Enhance instructions for contributors 2016-02-12 14:12:04 +01:00
Juan Linietsky 52326ac672 Update CONTRIBUTING.md 2016-02-09 12:48:20 -03:00
Juan Linietsky a84dfbc46b Added contributing.md 2016-02-08 13:33:21 -03:00