From fdfed15b302e25df9ae8bc87e33d82f919961a00 Mon Sep 17 00:00:00 2001 From: Lukas Tenbrink Date: Tue, 3 Feb 2026 01:29:56 +0100 Subject: [PATCH] Add a page documenting triage projects. --- index.rst | 1 + organization/areas.rst | 3 +- organization/how_to_contribute.rst | 4 ++ other/triage/index.rst | 2 + other/triage_projects.rst | 63 ++++++++++++++++++++++++++++++ 5 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 other/triage_projects.rst diff --git a/index.rst b/index.rst index dbbf182..43fa4d4 100644 --- a/index.rst +++ b/index.rst @@ -77,6 +77,7 @@ for your topic of interest. You can also use the search function in the top-left :caption: Other :name: sec-other + other/triage_projects other/triage/index other/triage_sprints other/translations diff --git a/organization/areas.rst b/organization/areas.rst index f08a260..d957ea8 100644 --- a/organization/areas.rst +++ b/organization/areas.rst @@ -16,7 +16,8 @@ For each team or area there is a list of links and resources associated with the * **GitHub labels**: lists any labels relevant to the team, and links to issues and PRs tagged with those tags. For more information about the different GitHub labels, please see the :ref:`doc_bug_triage_guidelines`. Note that some GitHub labels aren’t neatly covered by trackers. -* **Triage project**: links to the team triage project for the team. +* **Triage project**: links to the :ref:`team triage project ` for the team. You are welcome to + help the team out by implementing or reviewing something from this list. * **Maintainers**: lists the members of each team. The area maintainers take ownership of the area, and will steer its development by creating and reviewing pull requests and improvement proposals. Maintainers are listed alphabetically. Maintainers written as ⭐ **Member** (with a star and in bold) are team leads. diff --git a/organization/how_to_contribute.rst b/organization/how_to_contribute.rst index 7b7f8ae..991e65e 100644 --- a/organization/how_to_contribute.rst +++ b/organization/how_to_contribute.rst @@ -81,6 +81,10 @@ Participate in Godot's development The documentation is one of the most essential parts of any tech project, yet the need to document new features and substantial changes often gets overlooked. :ref:`Contribute documentation ` to improve the Godot Engine with your technical writing skills. +- **Review teams' triage projects** + Godot's development is organized by :ref:`teams `, and some of them maintain a public :ref:`triage project `. + You can make effective contributions by taking on tasks or discussing the issues and proposals in them. + - **Translations (spoken languages other than English)** Are you interested in making the Godot Engine more accessible to non-English speakers? Contribute to our :ref:`community translations ` on diff --git a/other/triage/index.rst b/other/triage/index.rst index 670d69f..7eb2a5d 100644 --- a/other/triage/index.rst +++ b/other/triage/index.rst @@ -1,3 +1,5 @@ +.. _doc_triage: + Bugsquad and triage =================== diff --git a/other/triage_projects.rst b/other/triage_projects.rst new file mode 100644 index 0000000..2ae84db --- /dev/null +++ b/other/triage_projects.rst @@ -0,0 +1,63 @@ +.. _doc_triage_projects: + +Helping out teams (using triage projects) +========================================= + +Godot is organized into :ref:`teams `, and some teams actively maintain a **triage project**. + +Triage projects can be seen as the teams' public to-do lists: It is where they keep track of bugs and proposals, +and organize them by importance and complexity. + +There are several ways to contribute, even if you are not a maintainer! Feel free to browse the issues +and help the team out by :ref:`implementing fixes ` or :ref:`reviewing pull requests `. + +Keep reading to learn how to do this effectively. + +How to use triage projects +-------------------------- + +Triage projects use GitHub's "Projects" feature, which you can learn more about in `GitHub's documentation `__. + +They are organized into tabs, each of which represents some view of the underlying data. Tabs may differ from team to +team; try several tabs to see which one is most useful to you. + +Below the tabs you will find a large table. Each **row** represents an **issue** (bug report or proposal), while +**columns** show different **aspects** of said issue. The following columns are of particular importance: + +- **Priority**: How important the issue is to the team (from ``low`` to ``critical``). +- **Complexity**: How difficult the solution may turn out to be. This is not a guarantee; just an educated guess by knowledgeable maintainers. +- **Status**: The latest evaluation of the issue by the team, with the following values: + - **For team assessment**: The team has not discussed or triaged the issue yet. + - **Up for grabs**: Any contributor is free to work on the issue. + - **Needs further info**: The team is waiting for more information on the issue. + - **In progress / assigned**: A maintainer is working on the issue. + - **Fix pending review**: A potential solution has been submitted and needs reviews. + - **Done**: The issue is closed and the problem solved. Huzzah! +- **Category**: Identifies the area of code the issue affects. +- **Assignees**: When maintainers work on an issue, they will link themselves here. Regular contributors cannot be linked as assignees. + +Keep in mind that values may be outdated, as there are a lot of issues to triage. You can bring issues to the +attention of maintainers in the `contributor chat `__. + +If you start working on an issue, but aren't a maintainer, please comment on the issue that you are doing so. + +Triage guidelines +----------------- + +.. note:: + + Only maintainers and members of the :team:`Bugsquad ` can edit triage projects, regular contributors + can only view them. To participate, get involved with the :ref:`teams ` or the :ref:`Bugsquad `! + +Generally, each team is free to use the triage projects as they see fit. Always consult with your +team about how to use the triage project effectively. + +That being said, here are some things to keep in mind: + +- **Respect our code of conduct.** Please keep in mind that triage projects are public. Use the "Comments" column respectfully. +- **Only triage what you know.** For example, if you don't know how complex a solution is going to be, it is better not to fill this value in than to guess. +- **Use triage projects to your advantage.** If you were hoping to implement a feature or track down a bug, + but can't get around to it, make an issue or proposal and link it in the triage project. Community members may come and help you out! +- **Be selective about "Up for grabs".** Contributors see this tag as a signal to start working on issues. + For proposals especially, please only use it if you actually want to see implementations for this proposal posted by the community. +- **Remember to work as a team.** If you disagree with the triage of an issue, please discuss it with the team before making changes.