s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

hacking.md: add more instructions

Browse Source 
Also make the examples more recent, so it doesn't look like it is outdated.

Part-of: <https://gitlab.gnome.org/World/Phosh/squeekboard/-/merge_requests/622>
This commit is contained in:
MoonlightWave-12
2024-03-10 14:38:37 +01:00
parent 65d470de8a
commit c4bd52e2f2
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/hacking.md
View File

@ -245,13 +245,13 @@ Packaging is in the `debian/` directory, and creates builds that can be quickly
``` ```
cd squeekboard-source cd squeekboard-source
gbp dch --multimaint-merge --ignore-branch EMAIL=my_address@example.com gbp dch --multimaint-merge --ignore-branch --git-author --distribution=experimental --new-version=x.y.z
``` ```
Inspect `debian/changelog`, and make sure the first line contains the correct version number and suite. For example: Inspect `debian/changelog`, and make sure the first line contains the correct version number and suite. For example:
``` ```
squeekboard (1.13.0pureos0~amber0) amber-phone; urgency=medium squeekboard (1.22.0) experimental; urgency=medium
``` ```
Add the updated `debian/changelog` to the commit. The commit message should contain the release version and a description of changes. Add the updated `debian/changelog` to the commit. The commit message should contain the release version and a description of changes.
@ -261,17 +261,17 @@ Add the updated `debian/changelog` to the commit. The commit message should cont
Summarize the changes since the last release in the NEWS file. Use the Markdown syntax, e.g. Summarize the changes since the last release in the NEWS file. Use the Markdown syntax, e.g.
``` ```
1.13.0 "Externality" 1.22.0 "Superposition"
----------------------------- -----------------------------
Changes: Changes:
- A system for latching and locking views - Fixed panel sizing when scaling
... ...
``` ```
### 6. Commit changes ### 6. Commit changes
Generate a commit message from the news file: Generate a commit message from the NEWS file:
``` ```
tools/make_message | git commit --file=- ... tools/make_message | git commit --file=- ...
@ -284,10 +284,10 @@ If the commit message looks wrong, fix the NEWS file, and do `git commit --amend
The tag should be the version number with "v" in front of it. The tag message should be "squeekboard" and the tag name. Push it to the upstream repository: The tag should be the version number with "v" in front of it. The tag message should be "squeekboard" and the tag name. Push it to the upstream repository:
``` ```
git tag -s -u my_address@example.com v1.13.0 -m "squeekboard v1.13.0" git tag -s -u my_address@example.com v1.22.0 -m "squeekboard v1.22.0"
git push v1.13.0 git push origin v1.22.0
``` ```
### 8. Rejoice ### 8. Rejoice
You released a new version of Squeekboard, and made it available on PureOS. Congratulations. You released a new version of Squeekboard. Congratulations!