diff options
Diffstat (limited to 'doc/contributing.asciidoc')
| -rw-r--r-- | doc/contributing.asciidoc | 75 |
1 files changed, 49 insertions, 26 deletions
diff --git a/doc/contributing.asciidoc b/doc/contributing.asciidoc index 50773f544..144117677 100644 --- a/doc/contributing.asciidoc +++ b/doc/contributing.asciidoc @@ -84,9 +84,9 @@ If you prefer to send a patch to the mailinglist, you can generate a patch based on your changes like this: ---- -git format-patch origin/master <1> +git format-patch origin/main <1> ---- -<1> Replace `master` by the branch your work was based on, e.g., +<1> Replace `main` by the branch your work was based on, e.g., `origin/develop`. Running qutebrowser @@ -575,35 +575,46 @@ Chrome URLs ~~~~~~~~~~~ With the QtWebEngine backend, qutebrowser supports several chrome:// urls which -can be useful for debugging: +can be useful for debugging. -- chrome://accessibility/ -- chrome://appcache-internals/ -- chrome://blob-internals/ -- chrome://conversion-internals/ (QtWebEngine 5.15.3+) -- chrome://crash/ (crashes the current renderer process!) +Info pages: + +- chrome://device-log/ (QtWebEngine >= 6.3) - chrome://gpu/ -- chrome://gpuclean/ (crashes the current renderer process!) -- chrome://gpucrash/ (crashes qutebrowser!) -- chrome://gpuhang/ (hangs qutebrowser!) +- chrome://sandbox/ (Linux only) + +Misc. / Debugging pages: + +- chrome://dino/ - chrome://histograms/ +- chrome://network-errors/ +- chrome://tracing/ (QtWebEngine >= 5.15.3) +- chrome://ukm/ (QtWebEngine >= 5.15.3) +- chrome://user-actions/ (QtWebEngine >= 5.15.3) +- chrome://webrtc-logs/ (QtWebEngine >= 5.15.3) + +Internals pages: + +- chrome://accessibility/ +- chrome://appcache-internals/ (QtWebEngine < 6.4) +- chrome://attribution-internals/ (QtWebEngine >= 6.4) +- chrome://blob-internals/ +- chrome://conversion-internals/ (QtWebEngine >= 5.15.3 and < 6.4) - chrome://indexeddb-internals/ -- chrome://kill/ (kills the current renderer process!) - chrome://media-internals/ -- chrome://net-internals/ (QtWebEngine 5.15.4+) -- chrome://network-errors/ -- chrome://ppapiflashcrash/ -- chrome://ppapiflashhang/ +- chrome://net-internals/ (QtWebEngine >= 5.15.4) - chrome://process-internals/ - chrome://quota-internals/ -- chrome://sandbox/ (Linux only) - chrome://serviceworker-internals/ -- chrome://taskscheduler-internals/ (removed in QtWebEngine 5.14) -- chrome://tracing/ (QtWebEngine 5.15.3+) -- chrome://ukm/ (QtWebEngine 5.15.3+) -- chrome://user-actions/ (QtWebEngine 5.15.3+) - chrome://webrtc-internals/ -- chrome://webrtc-logs/ (QtWebEngine 5.15.3+) + +Crash/hang pages: + +- chrome://crash/ (crashes the current renderer process!) +- chrome://gpuclean/ (crashes the current renderer process!) +- chrome://gpucrash/ (crashes qutebrowser!) +- chrome://gpuhang/ (hangs qutebrowser!) +- chrome://kill/ (kills the current renderer process!) QtWebEngine internals ~~~~~~~~~~~~~~~~~~~~~ @@ -758,18 +769,30 @@ qutebrowser release * Make sure there are no unstaged changes and the tests are green. * Make sure all issues with the related milestone are closed. +* Mark the https://github.com/qutebrowser/qutebrowser/milestones[milestone] as closed. * Consider updating the completions for `content.headers.user_agent` in `configdata.yml`. -* Minor release: Consider updating some files from master: +* Minor release: Consider updating some files from main: - `misc/requirements/` and `requirements.txt` - `scripts/` +* Update changelog in main branch and ensure the correct version number has `(unreleased)` +* If necessary: Update changelog in release branch from main. + +**Automatic release via GitHub Actions (starting with v3.0.0):** + +* Double check Python version in `.github/workflows/release.yml` +* Run the `release` workflow on the `main` branch, e.g. via `gh workflow run release -f release_type=major` (`release_type` can be `major`, `minor` or `patch`; you can also override `python_version`) + +**Manual release:** + * Make sure Python is up-to-date on build machines. -* Mark the milestone at https://github.com/qutebrowser/qutebrowser/milestones as closed. -* Update changelog in master branch -* If necessary: Update changelog in release branch from master. * Run `./.venv/bin/python3 scripts/dev/update_version.py {major,minor,patch}`. * Run the printed instructions accordingly. + +**Post release:** + * Update `qutebrowser-git` PKGBUILD if dependencies/install changed. * Add unreleased future versions to changelog * Update IRC topic * Announce to qutebrowser and qutebrowser-announce mailinglist. * Post announcement mail to subreddit +* Post on the website formerly known as Twitter |