Skip to content

Commit

Permalink
Document using browser search shortcuts to open issues faster
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronfranke committed Jan 3, 2025
1 parent d3a902e commit 00a1270
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions contributing/workflow/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ approach the project.
pr_workflow
pr_review_guidelines
testing_pull_requests
tips_and_tricks
37 changes: 37 additions & 0 deletions contributing/workflow/tips_and_tricks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. _doc_contributing_workflow_tips_and_tricks:

Tips and tricks
===============

This page contains a collection of tips and tricks to help you contribute more
efficiently. These are directed at "power users" who are already contributing
to the project and are looking for ways to streamline the process.

Open issues faster using browser search shortcuts
-------------------------------------------------

If you chat with engine developers outside of GitHub, you may encounter
plain issue numbers like "issue #12345" in conversations, without a link.
Rather than navigating the GitHub issue tracker to find the issue, you can
add a custom search engine to your browser to open issues faster.

For Chrome:

1. Go to the search engine settings page using ``chrome://settings/searchEngines``.
2. Scroll down to "Site search" in the lower middle of the page and click "Add".
3. Fill in the form with name "Godot GitHub", shortcut "#", and URL ``https://github.com/godotengine/godot/issues/%s``.
4. You can now type ``# 12345`` in the address bar to open issue #12345 (be sure to include the space).

For Firefox, the instructions are similar, but the "Add" button is hidden by default, so it needs to be enabled first:

1. Go to the ``about:config`` page.
2. Type ``browser.urlbar.update2.engineAliasRefresh`` in the search bar.
3. Click the "+" button to add a new boolean with this name (it should say ``true``).
4. Go to the search settings page using ``about:preferences#search``.
5. Scroll down to the bottom to find "Search Shortcuts" and click "Add".
6. Fill in the form with name "Godot GitHub", URL ``https://github.com/godotengine/godot/issues/%s``, and alias "#".
7. You can now type ``# 12345`` in the address bar to open issue #12345 (be sure to include the space).

The same shortcut works for both issues and PRs.
For example, number 12345 itself is actually a PR, and so ``# 12345``
will lead to ``https://github.com/godotengine/godot/pull/12345``.

0 comments on commit 00a1270

Please sign in to comment.