diff --git a/index.rst b/index.rst index 35a9306..b026e0c 100644 --- a/index.rst +++ b/index.rst @@ -26,6 +26,7 @@ for your topic of interest. You can also use the search function in the top-left organization/areas organization/pull_requests/index organization/general_rules_and_guidelines + organization/resources .. toctree:: :hidden: diff --git a/organization/resources.rst b/organization/resources.rst new file mode 100644 index 0000000..7c0892b --- /dev/null +++ b/organization/resources.rst @@ -0,0 +1,118 @@ +.. _doc_resources: + +Resources +========= + +This is a list of resources that people regularly refer to when contributing to Godot. +Most of these resources are part of the `Godot organization on GitHub `__, +but some are hosted elsewhere. + +Resources are sorted by alphabetical order. + +Benchmarks viewer +----------------- + +- **Link:** `benchmarks.godotengine.org `__ +- `Source code `__ + (maintained by `Calinou `__) + +Results viewer for `Godot benchmarks `__, +running daily on a dedicated server. + +Class reference status +---------------------- + +- **Link:** `godotengine.github.io/doc-status `__ +- `Source code `__ + (maintained by `Calinou `__) + +Tracks the class reference completion status for all classes exposed to the +scripting API. + +Commit artifacts +---------------- + +- **Link:** `godotengine.github.io/godot-commit-artifacts `__ +- `Source code `__ + (maintained by `akien-mga `__) + +Lists downloadable GitHub Actions build artifacts for every branch in the +Godot repository. This can be used to quickly download a build of the ``master`` +branch and test recent changes, without needing to compile from source. + +Note that these builds are *not* compiled with full optimizations. As a result, +they will be slower than official releases. + +Godot builds +------------ + +- **Link:** `github.com/godotengine/godot-builds `__ + +Lists all official Godot builds, including development builds. This also contains +information on which commit was used to compile each version, which is useful for +:ref:`bisecting regressions `. + +Interactive changelog +--------------------- + +- **Link:** `godot-proposals-viewer.github.io `__ +- `Source code `__ + (maintained by `Repiteo `__ and `akien-mga `__) + +Provides a way to visualize an automatically generated changelog between two +Godot versions. The changelog can be viewed as rich text or raw Markdown, +with headings present in every list item, or lists under headings for each section. + +This is used to automate changelog creation, as well as provide a basis +for highlights in release blog posts. + +Issue statistics +---------------- + +- **Link:** `godotengine.github.io/issue-stats `__ +- `Source code `__ + (maintained by `Calinou `__) + +Provides hardware and software statistics based on recent GitHub issue reports. +Since Godot does not contain telemetry, this allows getting an idea of what kind +of hardware is being used to run Godot. + +However, since it is purely based on voluntary issue reports, it is *not* fully +representative of what the community is using as a whole (let alone players +of games made with Godot). + +Proposals viewer +---------------- + +- **Link:** `godot-proposals-viewer.github.io `__ +- `Source code `__ + (maintained by `Calinou `__) + +A web viewer for the `Godot proposals `__ +repository. Unlike GitHub issue search, this viewer makes it possible to search +across all issue titles and author names without any pagination. It also provides +automatic sorting by popularity (based on reactions and comment count). + +Pull requests by file +--------------------- + +- **Link:** `godotengine.github.io/godot-prs-by-file `__ +- `Source code `__ + (maintained by `akien-mga `__) + +Lists pull requests that edit each file or folder in the Godot source tree. +This can be used to avoid duplicate work, or to find related pull requests +when working on a specific engine subsystem. + +Team reports +------------ + +- **Link:** `godotengine.github.io/godot-team-reports `__ +- `Source code `__ + (maintained by `akien-mga `__) + +Lists pull requests in a way that helps monitor stale and old PRs and +help clean up the review backlog. + +Pull requests are grouped by the teams assigned to review them, so that maintainers +have a good overview of their area of the engine.